Make example code more compact

cmarqu · cmarqu · commit ad810ffcee47 · 2025-05-14T17:10:46.000+02:00
diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
@@ -340,7 +340,7 @@ Why are default values shared between objects?
 This type of bug commonly bites neophyte programmers.  Consider this function::
 
    def foo(mydict={}):  # Danger: shared reference to one dict for all calls
-       # ... compute something ...
+       # compute something
        mydict[key] = value
        return mydict
 
@@ -382,8 +382,8 @@ requested again.  This is called "memoizing", and can be implemented like this::
            return _cache[(arg1, arg2)]
 
        # Calculate the value
-       result = ...  # ... expensive computation ...
-       _cache[(arg1, arg2)] = result           # Store result in the cache
+       result = ...  # expensive computation
+       _cache[(arg1, arg2)] = result  # Store result in the cache
        return result
 
 You could use a global variable containing a dictionary instead of the default
diff --git a/Doc/howto/ipaddress.rst b/Doc/howto/ipaddress.rst
@@ -254,8 +254,7 @@ It also means that network objects lend themselves to using the list
 membership test syntax like this::
 
    if address in network:
-       # do something
-       ...
+       ...  # do something
 
 Containment testing is done efficiently based on the network prefix::
 
diff --git a/Doc/howto/urllib2.rst b/Doc/howto/urllib2.rst
@@ -359,8 +359,7 @@ Number 1
         print('We failed to reach a server.')
         print('Reason: ', e.reason)
     else:
-        # everything is fine
-        ...
+        ...  # everything is fine
 
 
 .. note::
@@ -386,8 +385,7 @@ Number 2
             print('The server couldn\'t fulfill the request.')
             print('Error code: ', e.code)
     else:
-        # everything is fine
-        ...
+        ...  # everything is fine
 
 
 info and geturl
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
@@ -1655,8 +1655,7 @@ Do not instantiate the :class:`Server` class directly.
       srv = await loop.create_server(...)
 
       async with srv:
-          # some code
-          ...
+          ...  # some code
 
       # At this point, srv is closed and no longer accepts new connections.
 
diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst
@@ -51,8 +51,7 @@ Lock
 
        # ... later
        async with lock:
-           # access shared state
-           ...
+           ...  # access shared state
 
    which is equivalent to::
 
@@ -61,8 +60,7 @@ Lock
        # ... later
        await lock.acquire()
        try:
-           # access shared state
-           ...
+           ...  # access shared state
        finally:
            lock.release()
 
@@ -301,8 +299,7 @@ Semaphore
 
        # ... later
        async with sem:
-           # work with shared resource
-           ...
+           ...  # work with shared resource
 
    which is equivalent to::
 
@@ -311,8 +308,7 @@ Semaphore
        # ... later
        await sem.acquire()
        try:
-           # work with shared resource
-           ...
+           ...  # work with shared resource
        finally:
            sem.release()
 
diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
@@ -145,8 +145,7 @@ Functions and classes provided:
 
      @timeit()
      async def main():
-         # ... async code ...
-         ...
+         ...  # async code
 
    When used as a decorator, a new generator instance is implicitly created on
    each function call. This allows the otherwise "one-shot" context managers
@@ -242,8 +241,7 @@ Functions and classes provided:
               # Do not ignore any exceptions, cm has no effect.
               cm = contextlib.nullcontext()
           with cm:
-              # Do something
-              ...
+              ...  # Do something
 
    An example using *enter_result*::
 
@@ -256,8 +254,7 @@ Functions and classes provided:
               cm = nullcontext(file_or_path)
 
           with cm as file:
-              # Perform processing on the file
-              ...
+              ...  # Perform processing on the file
 
    It can also be used as a stand-in for
    :ref:`asynchronous context managers <async-context-managers>`::
@@ -271,8 +268,7 @@ Functions and classes provided:
                cm = nullcontext(session)
 
            async with cm as session:
-               # Send http requests with session
-               ...
+               ...  # Send http requests with session
 
    .. versionadded:: 3.7
 
@@ -442,15 +438,13 @@ Functions and classes provided:
 
       def f():
           with cm():
-              # Do stuff
-              ...
+              ...  # Do stuff
 
    ``ContextDecorator`` lets you instead write::
 
       @cm()
       def f():
-          # Do stuff
-          ...
+          ...  # Do stuff
 
    It makes it clear that the ``cm`` applies to the whole function, rather than
    just a piece of it (and saving an indentation level is nice, too).
@@ -712,12 +706,10 @@ protocol can be separated slightly in order to allow this::
    try:
        x = stack.enter_context(cm)
    except Exception:
-       # handle __enter__ exception
-       ...
+       ...  # handle __enter__ exception
    else:
        with stack:
-           # Handle normal case
-           ...
+           ...  # Handle normal case
 
 Actually needing to do this is likely to indicate that the underlying API
 should be providing a direct resource management interface for use with
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
@@ -1404,8 +1404,7 @@ is considered deprecated and may be removed in the future.
       def handle_stackframe_without_leak():
           frame = inspect.currentframe()
           try:
-              # do something with the frame
-              ...
+              ...  # do something with the frame
           finally:
               del frame
 
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
@@ -1175,8 +1175,7 @@ functions.
    not undo customizations already applied by other code. For example::
 
       class MyLogger(logging.getLoggerClass()):
-          # ... override behaviour here
-          ...
+          ...  # override behaviour here
 
 
 .. function:: getLogRecordFactory()
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
@@ -2935,8 +2935,7 @@ Explicitly pass resources to child processes
         from multiprocessing import Process, Lock
 
         def f():
-            # ... do something using "lock" ...
-            ...
+            ...  # do something using "lock"
 
         if __name__ == '__main__':
             lock = Lock()
@@ -2948,8 +2947,7 @@ Explicitly pass resources to child processes
         from multiprocessing import Process, Lock
 
         def f(l):
-            # ... do something using "l" ...
-            ...
+            ...  # do something using "l"
 
         if __name__ == '__main__':
             lock = Lock()
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
@@ -1461,8 +1461,7 @@ always available. Unless explicitly noted otherwise, all variables are read-only
    recommended to use the following idiom::
 
       if sys.platform.startswith('sunos'):
-          # SunOS-specific code here...
-          ...
+          ...  # SunOS-specific code here
 
    .. versionchanged:: 3.3
       On Linux, :data:`sys.platform` doesn't contain the major version anymore.
diff --git a/Doc/library/test.rst b/Doc/library/test.rst
@@ -62,30 +62,25 @@ A basic boilerplate is often used::
        # Only use setUp() and tearDown() if necessary
 
        def setUp(self):
-           # ... code to execute in preparation for tests ...
-           ...
+           ...  # code to execute in preparation for tests
 
        def tearDown(self):
-           # ... code to execute to clean up after tests ...
-           ...
+           ...  # code to execute to clean up after tests
 
        def test_feature_one(self):
            # Test feature one.
-           # ... testing code ...
-           ...
+           ...  # testing code
 
        def test_feature_two(self):
            # Test feature two.
-           # ... testing code ...
-           ...
+           ...  # testing code
 
-       # ... more test methods ...
+       # more test methods
 
    class MyTestCase2(unittest.TestCase):
-       # ... same structure as MyTestCase1 ...
-       ...
+       ...  # same structure as MyTestCase1
 
-   # ... more test classes ...
+   # more test classes
 
    if __name__ == '__main__':
        unittest.main()
@@ -1687,8 +1682,7 @@ The :mod:`test.support.warnings_helper` module provides support for warnings tes
 
       @warning_helper.ignore_warnings(category=DeprecationWarning)
       def test_suppress_warning():
-          # do something
-          ...
+          ...  # do something
 
    .. versionadded:: 3.8
 
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
@@ -982,8 +982,7 @@ when they need to connect to the server::
    with pool_sema:
        conn = connectdb()
        try:
-           # ... use connection ...
-           ...
+           ...  # use connection
        finally:
            conn.close()
 
@@ -1202,15 +1201,13 @@ entered, and ``release`` will be called when the block is exited.  Hence,
 the following snippet::
 
    with some_lock:
-       # do something...
-       ...
+       ...  # do something
 
 is equivalent to::
 
    some_lock.acquire()
    try:
-       # do something...
-       ...
+       ...  # do something
    finally:
        some_lock.release()
 
diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst
@@ -587,8 +587,7 @@ third party, such as running code when a module is unloaded::
 
     import weakref, sys
     def unloading_module():
-        # implicit reference to the module globals from the function body
-        ...
+        ...  # implicit reference to the module globals from the function body
     weakref.finalize(sys.modules[__name__], unloading_module)
 
 
diff --git a/Doc/whatsnew/3.7.rst b/Doc/whatsnew/3.7.rst
@@ -716,8 +716,7 @@ include:
       srv = await loop.create_server(...)
 
       async with srv:
-          # some code
-          ...
+          ...  # some code
 
       # At this point, srv is closed and no longer accepts new connections.
 
diff --git a/Doc/whatsnew/3.8.rst b/Doc/whatsnew/3.8.rst
@@ -180,8 +180,7 @@ is an excerpt from code in the :mod:`collections` module::
   class Counter(dict):
 
       def __init__(self, iterable=None, /, **kwds):
-          # Note "iterable" is a possible keyword argument
-          ...
+          ...  # Note "iterable" is a possible keyword argument
 
 See :pep:`570` for a full description.
 
