]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] docs: fix a few typos identified by codespell (GH-119516) (#119571)
authorHugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sun, 26 May 2024 08:15:57 +0000 (11:15 +0300)
committerGitHub <noreply@github.com>
Sun, 26 May 2024 08:15:57 +0000 (08:15 +0000)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
17 files changed:
Doc/c-api/weakref.rst
Doc/extending/extending.rst
Doc/extending/newtypes.rst
Doc/howto/mro.rst
Doc/library/curses.rst
Doc/library/numbers.rst
Doc/library/optparse.rst
Doc/library/ssl.rst
Doc/library/textwrap.rst
Doc/library/turtle.rst
Doc/tutorial/venv.rst
Doc/whatsnew/2.2.rst
Doc/whatsnew/2.7.rst
Doc/whatsnew/3.12.rst
Doc/whatsnew/3.4.rst
Doc/whatsnew/3.6.rst
Doc/whatsnew/3.9.rst

index f46507608606b9d209a4b7175a36e97b4e744dd8..c0bfab7fb939f1630e63f4f58177100c4c7464aa 100644 (file)
@@ -35,7 +35,7 @@ as much as it can.
    callable object that receives notification when *ob* is garbage collected; it
    should accept a single parameter, which will be the weak reference object
    itself. *callback* may also be ``None`` or ``NULL``.  If *ob* is not a
-   weakly referencable object, or if *callback* is not callable, ``None``, or
+   weakly referenceable object, or if *callback* is not callable, ``None``, or
    ``NULL``, this will return ``NULL`` and raise :exc:`TypeError`.
 
 
@@ -47,7 +47,7 @@ as much as it can.
    be a callable object that receives notification when *ob* is garbage
    collected; it should accept a single parameter, which will be the weak
    reference object itself. *callback* may also be ``None`` or ``NULL``.  If *ob*
-   is not a weakly referencable object, or if *callback* is not callable,
+   is not a weakly referenceable object, or if *callback* is not callable,
    ``None``, or ``NULL``, this will return ``NULL`` and raise :exc:`TypeError`.
 
 
index 394948a4d2ea6b162b3602c96c9f727504bed215..58f4d3669889b09d871fc31cbb06eaded8b2c854 100644 (file)
@@ -857,7 +857,7 @@ It is important to call :c:func:`free` at the right time.  If a block's address
 is forgotten but :c:func:`free` is not called for it, the memory it occupies
 cannot be reused until the program terminates.  This is called a :dfn:`memory
 leak`.  On the other hand, if a program calls :c:func:`free` for a block and then
-continues to use the block, it creates a conflict with re-use of the block
+continues to use the block, it creates a conflict with reuse of the block
 through another :c:func:`malloc` call.  This is called :dfn:`using freed memory`.
 It has the same bad consequences as referencing uninitialized data --- core
 dumps, wrong results, mysterious crashes.
index e69a5808b2335d9bab004858fde5b432cde45669..cb553cc221232983e9e32af058a76265a93f9755 100644 (file)
@@ -545,7 +545,7 @@ performance-critical objects (such as numbers).
 .. seealso::
    Documentation for the :mod:`weakref` module.
 
-For an object to be weakly referencable, the extension type must set the
+For an object to be weakly referenceable, the extension type must set the
 ``Py_TPFLAGS_MANAGED_WEAKREF`` bit of the :c:member:`~PyTypeObject.tp_flags`
 field. The legacy :c:member:`~PyTypeObject.tp_weaklistoffset` field should
 be left as zero.
index a44ef6848af4f3d7f59307f4e3b83562e61d4fbd..f44b4f98e570bda9cc3d8978dd30fb6b84999f05 100644 (file)
@@ -426,7 +426,7 @@ In this case the MRO is GFEF and the local precedence ordering is
 preserved.
 
 As a general rule, hierarchies such as the previous one should be
-avoided, since it is unclear if F should override E or viceversa.
+avoided, since it is unclear if F should override E or vice-versa.
 Python 2.3 solves the ambiguity by raising an exception in the creation
 of class G, effectively stopping the programmer from generating
 ambiguous hierarchies.  The reason for that is that the C3 algorithm
index b6af96156a6b6c418e1e724738a767dc6244c85e..2ebda3d3396ac6a9727c649786125c1d4a98e5a9 100644 (file)
@@ -922,7 +922,7 @@ the following methods and attributes:
 
 .. method:: window.getbegyx()
 
-   Return a tuple ``(y, x)`` of co-ordinates of upper-left corner.
+   Return a tuple ``(y, x)`` of coordinates of upper-left corner.
 
 
 .. method:: window.getbkgd()
index 5f59746fa598124c2beedd775fe9dfd7cb37e678..d0ae79c7a3df762574f491e7fcc251a5cf49793a 100644 (file)
@@ -84,10 +84,10 @@ The numeric tower
    ``~``.
 
 
-Notes for type implementors
+Notes for type implementers
 ---------------------------
 
-Implementors should be careful to make equal numbers equal and hash
+Implementers should be careful to make equal numbers equal and hash
 them to the same values. This may be subtle if there are two different
 extensions of the real numbers. For example, :class:`fractions.Fraction`
 implements :func:`hash` as follows::
index c5ae2ed88da9b1e371a7dc75356e6f6e9193946c..fc652d23f4f880e84bd07664c1fe1d30f7cc4ec4 100644 (file)
@@ -1738,7 +1738,7 @@ seen, but blow up if it comes after ``-b`` in the command-line.  ::
 Callback example 3: check option order (generalized)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-If you want to re-use this callback for several similar options (set a flag, but
+If you want to reuse this callback for several similar options (set a flag, but
 blow up if ``-b`` has already been seen), it needs a bit of work: the error
 message and the flag that it sets must be generalized.  ::
 
index 834d436752a2cc31e90f7be37d517e8c4731b50f..8fb0d5056c117d0ffdcf29364d52cad5892ed796 100644 (file)
@@ -759,7 +759,7 @@ Constants
 
 .. data:: OP_SINGLE_DH_USE
 
-   Prevents re-use of the same DH key for distinct SSL sessions.  This
+   Prevents reuse of the same DH key for distinct SSL sessions.  This
    improves forward secrecy but requires more computational resources.
    This option only applies to server sockets.
 
@@ -767,7 +767,7 @@ Constants
 
 .. data:: OP_SINGLE_ECDH_USE
 
-   Prevents re-use of the same ECDH key for distinct SSL sessions.  This
+   Prevents reuse of the same ECDH key for distinct SSL sessions.  This
    improves forward secrecy but requires more computational resources.
    This option only applies to server sockets.
 
index deaefeee7b8c999296d14b493a8e182786e004d9..a58b460fef409c6921d6819322b846c75c20883b 100644 (file)
@@ -154,7 +154,7 @@ hyphenated words; only then will long words be broken if necessary, unless
       wrapper = TextWrapper()
       wrapper.initial_indent = "* "
 
-   You can re-use the same :class:`TextWrapper` object many times, and you can
+   You can reuse the same :class:`TextWrapper` object many times, and you can
    change any of its options through direct assignment to instance attributes
    between uses.
 
index ae05b2059a98c2dc90289703319e7967693d61af..ea5e21f1da48d01d7694c71717b62b33b35bc375 100644 (file)
@@ -111,7 +111,7 @@ off-screen)::
    home()
 
 The home position is at the center of the turtle's screen. If you ever need to
-know them, get the turtle's x-y co-ordinates with::
+know them, get the turtle's x-y coordinates with::
 
     pos()
 
index 6cca3f1b25aadc2a92bd05f99acc672113f3426e..91e4ce18acef1dd8c390aedd41829ded0205a21e 100644 (file)
@@ -38,7 +38,7 @@ Creating Virtual Environments
 The module used to create and manage virtual environments is called
 :mod:`venv`.  :mod:`venv` will install the Python version from which
 the command was run (as reported by the :option:`--version` option).
-For instance, excuting the command with ``python3.12`` will install
+For instance, executing the command with ``python3.12`` will install
 version 3.12.
 
 To create a virtual environment, decide upon a directory where you want to
index e6c13f957b8d54a254b1815ba5d4127ccc844be6..d4dbe0570fbda513aff0240ff351a1dae505bdd8 100644 (file)
@@ -1062,7 +1062,7 @@ code, none of the changes described here will affect you very much.
   simply been changed to use the new C-level interface.  (Contributed by Fred L.
   Drake, Jr.)
 
-* Another low-level API, primarily of interest to implementors of Python
+* Another low-level API, primarily of interest to implementers of Python
   debuggers and development tools, was added. :c:func:`PyInterpreterState_Head` and
   :c:func:`PyInterpreterState_Next` let a caller walk through all the existing
   interpreter objects; :c:func:`PyInterpreterState_ThreadHead` and
index 63a8e6034b0719740f1c696e06141566ebb668aa..585c704af1ff591ed9806a5a53dca0b130fd0b5a 100644 (file)
@@ -1738,7 +1738,7 @@ New module: importlib
 
 Python 3.1 includes the :mod:`importlib` package, a re-implementation
 of the logic underlying Python's :keyword:`import` statement.
-:mod:`importlib` is useful for implementors of Python interpreters and
+:mod:`importlib` is useful for implementers of Python interpreters and
 to users who wish to write new importers that can participate in the
 import process.  Python 2.7 doesn't contain the complete
 :mod:`importlib` package, but instead has a tiny subset that contains
index 9c4101f3870d5f3e12173871b9d5420a23ecb137..6ba04c6227bc0b20fbaf4457957f326c279d2466 100644 (file)
@@ -1262,7 +1262,7 @@ Deprecated
     :exc:`DeprecationWarning` when it can detect being called from a
     multithreaded process. There has always been a fundamental incompatibility
     with the POSIX platform when doing so. Even if such code *appeared* to work.
-    We added the warning to to raise awareness as issues encounted by code doing
+    We added the warning to raise awareness as issues encountered by code doing
     this are becoming more frequent. See the :func:`os.fork` documentation for
     more details along with `this discussion on fork being incompatible with threads
     <https://discuss.python.org/t/33555>`_ for *why* we're now surfacing this
index 5a629cd78aba11f5fdb573b091bb73181085334a..33635c6db93d3ae7faa41fd5bfa58689b755621c 100644 (file)
@@ -2413,7 +2413,7 @@ Changes in the Python API
   formal public interface the naming has been made consistent (:issue:`18532`).
 
 * Because :mod:`unittest.TestSuite` now drops references to tests after they
-  are run, test harnesses that re-use a :class:`~unittest.TestSuite` to re-run
+  are run, test harnesses that reuse a :class:`~unittest.TestSuite` to re-run
   a set of tests may fail.   Test suites should not be re-used in this fashion
   since it means state is retained between test runs, breaking the test
   isolation that :mod:`unittest` is designed to provide.  However, if the lack
index a73bc33f8f80f3b0e1507c3d167bf5b93217ab37..e91e6dc11b9adc1f3c277f8b12d4979eae16492f 100644 (file)
@@ -2336,10 +2336,10 @@ Changes in the Python API
 * With the introduction of :exc:`ModuleNotFoundError`, import system consumers
   may start expecting import system replacements to raise that more specific
   exception when appropriate, rather than the less-specific :exc:`ImportError`.
-  To provide future compatibility with such consumers, implementors of
+  To provide future compatibility with such consumers, implementers of
   alternative import systems that completely replace :func:`__import__` will
   need to update their implementations to raise the new subclass when a module
-  can't be found at all. Implementors of compliant plugins to the default
+  can't be found at all. Implementers of compliant plugins to the default
   import system shouldn't need to make any changes, as the default import
   system will raise the new subclass when appropriate.
 
index 27a707c970d9b08bafe370b3d002aff7f9186a63..f32224aefc07218929ee33a607bf5849f01e8bd7 100644 (file)
@@ -891,7 +891,7 @@ Deprecated
 
 * Deprecated the ``split()`` method of :class:`!_tkinter.TkappType` in
   favour of the ``splitlist()`` method which has more consistent and
-  predicable behavior.
+  predictable behavior.
   (Contributed by Serhiy Storchaka in :issue:`38371`.)
 
 * The explicit passing of coroutine objects to :func:`asyncio.wait` has been