Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use example.com for documentation #91611

Closed
narusemotoki opened this issue Apr 16, 2022 · 2 comments
Closed

use example.com for documentation #91611

narusemotoki opened this issue Apr 16, 2022 · 2 comments
Labels
docs Documentation in the Doc dir easy

Comments

@narusemotoki
Copy link
Contributor

narusemotoki commented Apr 16, 2022 •
edited

Documentation

Hello,
I found mydomain.com in the documentation. I would prefer to use example.com instead of that domain.

The domain names example.com, example.net, example.org, and example.edu are second-level domain names in the Domain Name System of the Internet. They are reserved by the Internet Assigned Numbers Authority (IANA) at the direction of the Internet Engineering Task Force (IETF) as special-use domain names for documentation purposes. The domain names are used widely in books, tutorials, sample network configurations, and generally as examples for the use of domain names. The Internet Corporation for Assigned Names and Numbers (ICANN) operates web sites for these domains with content that reflects their purpose.

https://en.wikipedia.org/wiki/Example.com

example.net, org and edu are also good.

mydomain.com is here

I will send a Pull Request.
@narusemotoki narusemotoki added the docs Documentation in the Doc dir label Apr 16, 2022
narusemotoki added a commit to narusemotoki/cpython that referenced this issue Apr 16, 2022
@narusemotoki
pythongh-91611: Use example.com for documentation. Not others' domain.
47f336f 
example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.

On the other hand, mydomain.com is real Domain Name Registration service.
@narusemotoki narusemotoki mentioned this issue Apr 16, 2022
Merged
@rhettinger
Copy link
Contributor

rhettinger commented Apr 17, 2022

When you make the PR, request a review from me and I'll push it through.

JelleZijlstra pushed a commit that referenced this issue Apr 30, 2022
@narusemotoki
gh-91611: Use example.com for documentation, not mydomain.com (#91613)
ea39246 
example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.

On the other hand, mydomain.com is real Domain Name Registration service.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 30, 2022
@narusemotoki @miss-islington
pythongh-91611: Use example.com for documentation, not mydomain.com (p…
2ddcd4a 
…ythonGH-91613)

example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.

On the other hand, mydomain.com is real Domain Name Registration service.
(cherry picked from commit ea39246)

Co-authored-by: Motoki Naruse <motoki@naru.se>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 30, 2022
@narusemotoki @miss-islington
pythongh-91611: Use example.com for documentation, not mydomain.com (p…
39ec44c 
…ythonGH-91613)

example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.

On the other hand, mydomain.com is real Domain Name Registration service.
(cherry picked from commit ea39246)

Co-authored-by: Motoki Naruse <motoki@naru.se>
miss-islington added a commit that referenced this issue May 1, 2022
@miss-islington @narusemotoki
gh-91611: Use example.com for documentation, not mydomain.com (GH-91613)
cef3a99 
example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.

On the other hand, mydomain.com is real Domain Name Registration service.
(cherry picked from commit ea39246)

Co-authored-by: Motoki Naruse <motoki@naru.se>
miss-islington added a commit that referenced this issue May 1, 2022
@miss-islington @narusemotoki
gh-91611: Use example.com for documentation, not mydomain.com (GH-91613)
31e35be 
example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.

On the other hand, mydomain.com is real Domain Name Registration service.
(cherry picked from commit ea39246)

Co-authored-by: Motoki Naruse <motoki@naru.se>
@hauntsaninja
Copy link
Contributor

hauntsaninja commented May 13, 2022 •
edited

Thanks, this appears to have been fixed

hello-adam pushed a commit to hello-adam/cpython that referenced this issue Jun 2, 2022
@miss-islington @narusemotoki @hello-adam
pythongh-91611: Use example.com for documentation, not mydomain.com (p…
e3e6ad5 
…ythonGH-91613)

example.com is reserved by the IANA as special-use domain name for documentation
purposes. The domain names are used widely in books, tutorials, sample network
configurations, and generally as examples for the use of domain name.

On the other hand, mydomain.com is real Domain Name Registration service.
(cherry picked from commit ea39246)

Co-authored-by: Motoki Naruse <motoki@naru.se>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@narusemotoki @rhettinger @hauntsaninja