[Python-checkins] gh-91611: Use example.com for documentation, not mydomain.com (GH-91613)

miss-islington webhook-mailer at python.org
Sun May 1 00:02:56 EDT 2022


https://github.com/python/cpython/commit/cef3a994c7c966511563edc45292ec8f69770268
commit: cef3a994c7c966511563edc45292ec8f69770268
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-04-30T21:02:51-07:00
summary:

gh-91611: Use example.com for documentation, not mydomain.com (GH-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 ea392467829d6e93f824bde8eb87bdb31d9e4c62)

Co-authored-by: Motoki Naruse <motoki at naru.se>

files:
M Doc/library/secrets.rst
M Doc/library/ssl.rst

diff --git a/Doc/library/secrets.rst b/Doc/library/secrets.rst
index afa8e2d385fa4..c22da727b55c9 100644
--- a/Doc/library/secrets.rst
+++ b/Doc/library/secrets.rst
@@ -193,7 +193,7 @@ suitable for password recovery applications:
 .. testcode::
 
    import secrets
-   url = 'https://mydomain.com/reset=' + secrets.token_urlsafe()
+   url = 'https://example.com/reset=' + secrets.token_urlsafe()
 
 
 
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index f5446808cbdeb..af9bf798da3b4 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -2345,7 +2345,7 @@ waiting for clients to connect::
    context.load_cert_chain(certfile="mycertfile", keyfile="mykeyfile")
 
    bindsocket = socket.socket()
-   bindsocket.bind(('myaddr.mydomain.com', 10023))
+   bindsocket.bind(('myaddr.example.com', 10023))
    bindsocket.listen(5)
 
 When a client connects, you'll call :meth:`accept` on the socket to get the



More information about the Python-checkins mailing list