]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] Docs: spelling and grammar fixes (GH-122084) (#122106)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 22 Jul 2024 01:30:34 +0000 (03:30 +0200)
committerGitHub <noreply@github.com>
Mon, 22 Jul 2024 01:30:34 +0000 (01:30 +0000)
Docs: spelling and grammar fixes (GH-122084)

Corrected some grammar and spelling issues in documentation.

(cherry picked from commit bc264eac3ad14dab748e33b3d714c2674872791f)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
22 files changed:
Doc/c-api/init_config.rst
Doc/howto/free-threading-extensions.rst
Doc/howto/logging-cookbook.rst
Doc/library/ast.rst
Doc/library/asyncio-future.rst
Doc/library/asyncio-task.rst
Doc/library/contextlib.rst
Doc/library/ctypes.rst
Doc/library/fractions.rst
Doc/library/http.server.rst
Doc/library/importlib.resources.abc.rst
Doc/library/importlib.rst
Doc/library/inspect.rst
Doc/library/mailbox.rst
Doc/library/optparse.rst
Doc/library/os.rst
Doc/library/pathlib.rst
Doc/library/plistlib.rst
Doc/library/ssl.rst
Doc/library/subprocess.rst
Doc/library/urllib.request.rst
Doc/using/ios.rst

index 5195f6cccfe9dfdb7c6c806f628dd93fbb7c6cd3..6e2e04fba55a45a999b9fe76cc5b97d19cde72bd 100644 (file)
@@ -509,7 +509,7 @@ PyConfig
       The :c:func:`PyConfig_Read` function only parses
       :c:member:`PyConfig.argv` arguments once: :c:member:`PyConfig.parse_argv`
       is set to ``2`` after arguments are parsed. Since Python arguments are
-      strippped from :c:member:`PyConfig.argv`, parsing arguments twice would
+      stripped from :c:member:`PyConfig.argv`, parsing arguments twice would
       parse the application options as Python options.
 
       :ref:`Preinitialize Python <c-preinit>` if needed.
@@ -1041,7 +1041,7 @@ PyConfig
       The :c:func:`PyConfig_Read` function only parses
       :c:member:`PyConfig.argv` arguments once: :c:member:`PyConfig.parse_argv`
       is set to ``2`` after arguments are parsed. Since Python arguments are
-      strippped from :c:member:`PyConfig.argv`, parsing arguments twice would
+      stripped from :c:member:`PyConfig.argv`, parsing arguments twice would
       parse the application options as Python options.
 
       Default: ``1`` in Python mode, ``0`` in isolated mode.
index 1ba91b09516f9c738bc7d89db587689bf1c5f349..521810e2887f2f3987440ea124c19a460b4a8184 100644 (file)
@@ -188,7 +188,7 @@ Python's memory management C API provides functions in three different
 :ref:`allocation domains <allocator-domains>`: "raw", "mem", and "object".
 For thread-safety, the free-threaded build requires that only Python objects
 are allocated using the object domain, and that all Python object are
-allocated using that domain.  This differes from the prior Python versions,
+allocated using that domain.  This differs from the prior Python versions,
 where this was only a best practice and not a hard requirement.
 
 .. note::
index 60d88204b795f65c92f5a4d62d78f7ee7dd260f7..96768ec4ae31f14eaea89e66b6b808c84616a2ad 100644 (file)
@@ -4022,7 +4022,7 @@ As you can see, this output isn't ideal. That's because the underlying code
 which writes to ``sys.stderr`` makes multiple writes, each of which results in a
 separate logged line (for example, the last three lines above). To get around
 this problem, you need to buffer things and only output log lines when newlines
-are seen. Let's use a slghtly better implementation of ``LoggerWriter``:
+are seen. Let's use a slightly better implementation of ``LoggerWriter``:
 
 .. code-block:: python
 
index 727d44df0c8b4a85a91793c60ee222036129d07f..24014e628aed7b343f19a4ad8678945b4a544452 100644 (file)
@@ -887,7 +887,7 @@ Statements
 .. class:: AnnAssign(target, annotation, value, simple)
 
    An assignment with a type annotation. ``target`` is a single node and can
-   be a :class:`Name`, a :class:`Attribute` or a :class:`Subscript`.
+   be a :class:`Name`, an :class:`Attribute` or a :class:`Subscript`.
    ``annotation`` is the annotation, such as a :class:`Constant` or :class:`Name`
    node. ``value`` is a single optional node.
 
@@ -1979,7 +1979,7 @@ Function and class definitions
            YieldFrom(value)
 
    A ``yield`` or ``yield from`` expression. Because these are expressions, they
-   must be wrapped in a :class:`Expr` node if the value sent back is not used.
+   must be wrapped in an :class:`Expr` node if the value sent back is not used.
 
    .. doctest::
 
index 893ae5518f757d81c5fe971c818e7553b1fc3321..9dce073141194013f2b636faa227e79edc9caa1f 100644 (file)
@@ -120,20 +120,20 @@ Future Object
       a :exc:`CancelledError` exception.
 
       If the Future's result isn't yet available, this method raises
-      a :exc:`InvalidStateError` exception.
+      an :exc:`InvalidStateError` exception.
 
    .. method:: set_result(result)
 
       Mark the Future as *done* and set its result.
 
-      Raises a :exc:`InvalidStateError` error if the Future is
+      Raises an :exc:`InvalidStateError` error if the Future is
       already *done*.
 
    .. method:: set_exception(exception)
 
       Mark the Future as *done* and set an exception.
 
-      Raises a :exc:`InvalidStateError` error if the Future is
+      Raises an :exc:`InvalidStateError` error if the Future is
       already *done*.
 
    .. method:: done()
index c5deac7e2748ae3e53b5148b70e2c8862e56afc9..abf1726b34f5393032e9ac5ab211d87444a09bc9 100644 (file)
@@ -1170,7 +1170,7 @@ Task Object
       a :exc:`CancelledError` exception.
 
       If the Task's result isn't yet available, this method raises
-      a :exc:`InvalidStateError` exception.
+      an :exc:`InvalidStateError` exception.
 
    .. method:: exception()
 
index 27cf99446e5980471561d6235b251ca5c9e2ef30..f5b349441bcfee5a3d4947d6febd2f94882643b3 100644 (file)
@@ -322,7 +322,7 @@ Functions and classes provided:
 
    .. versionchanged:: 3.12
       ``suppress`` now supports suppressing exceptions raised as
-      part of an :exc:`BaseExceptionGroup`.
+      part of a :exc:`BaseExceptionGroup`.
 
 .. function:: redirect_stdout(new_target)
 
index 820535e3cba106f19512b82e69308739dd9eacfe..d890d904ef4e6c5936fc22dbb6104627ef37fb4c 100644 (file)
@@ -107,7 +107,7 @@ Functions are accessed as attributes of dll objects::
 
 Note that win32 system dlls like ``kernel32`` and ``user32`` often export ANSI
 as well as UNICODE versions of a function. The UNICODE version is exported with
-an ``W`` appended to the name, while the ANSI version is exported with an ``A``
+a ``W`` appended to the name, while the ANSI version is exported with an ``A``
 appended to the name. The win32 ``GetModuleHandle`` function, which returns a
 *module handle* for a given module name, has the following C prototype, and a
 macro is used to expose one of them as ``GetModuleHandle`` depending on whether
index d2028d0ca34c755c34b1e05cb75d2c57442b38cb..7e615ed230a340bdf4c8c0d6f4bf5640771bc31c 100644 (file)
@@ -87,7 +87,7 @@ another rational number, or from a string.
 
    .. versionchanged:: 3.9
       The :func:`math.gcd` function is now used to normalize the *numerator*
-      and *denominator*. :func:`math.gcd` always return a :class:`int` type.
+      and *denominator*. :func:`math.gcd` always returns an :class:`int` type.
       Previously, the GCD type depended on *numerator* and *denominator*.
 
    .. versionchanged:: 3.11
index 3c80fa747d5f1ff311204f48c4fab92375344c1b..9ed92dc695737026a9a665134c7c6c67376108e5 100644 (file)
@@ -378,7 +378,7 @@ provides three different variants:
 
       If the request was mapped to a file, it is opened. Any :exc:`OSError`
       exception in opening the requested file is mapped to a ``404``,
-      ``'File not found'`` error. If there was a ``'If-Modified-Since'``
+      ``'File not found'`` error. If there was an ``'If-Modified-Since'``
       header in the request, and the file was not modified after this time,
       a ``304``, ``'Not Modified'`` response is sent. Otherwise, the content
       type is guessed by calling the :meth:`guess_type` method, which in turn
index 5ea8044e1ec6caa4d1daeb4484980f67eb86f5d4..54995ddbfbca128f06c327b4fd8afbdf4e3a0bb2 100644 (file)
@@ -22,7 +22,7 @@
     something like a data file that lives next to the ``__init__.py``
     file of the package. The purpose of this class is to help abstract
     out the accessing of such data files so that it does not matter if
-    the package and its data file(s) are stored in a e.g. zip file
+    the package and its data file(s) are stored e.g. in a zip file
     versus on the file system.
 
     For any of methods of this class, a *resource* argument is
index b58ef359378e4f7262b5da8f7979ca570deceb07..c7faf8ba21890a855fbad18c4dbd2cc42ef691bd 100644 (file)
@@ -657,7 +657,7 @@ ABC hierarchy::
     something like a data file that lives next to the ``__init__.py``
     file of the package. The purpose of this class is to help abstract
     out the accessing of such data files so that it does not matter if
-    the package and its data file(s) are stored in a e.g. zip file
+    the package and its data file(s) are stored e.g. in a zip file
     versus on the file system.
 
     For any of methods of this class, a *resource* argument is
index 7838eeed2843c4d7ccd95aa6692c51fba59068ff..361f4054856d89ddfdf326c14e13d7389ab8e0e1 100644 (file)
@@ -457,7 +457,7 @@ attributes (see :ref:`import-mod-attrs` for module attributes):
 
    .. versionchanged:: 3.8
       Functions wrapped in :func:`functools.partial` now return ``True`` if the
-      wrapped function is a :term:`asynchronous generator` function.
+      wrapped function is an :term:`asynchronous generator` function.
 
    .. versionchanged:: 3.13
       Functions wrapped in :func:`functools.partialmethod` now return ``True``
@@ -938,7 +938,7 @@ function.
 
    .. attribute:: Parameter.kind.description
 
-      Describes a enum value of :attr:`Parameter.kind`.
+      Describes an enum value of :attr:`Parameter.kind`.
 
       .. versionadded:: 3.8
 
index 40ea71cd342b47592ca275d21007e6778a9bba87..abb32f9bf3457f95bbf86316aaa0b071106e7efc 100644 (file)
@@ -1387,7 +1387,7 @@ When an :class:`!MHMessage` instance is created based upon a
 
    .. method:: get_visible()
 
-      Return an :class:`Message` instance whose headers are the message's
+      Return a :class:`Message` instance whose headers are the message's
       visible headers and whose body is empty.
 
 
index 3e96259f94d47b43f85b778ba824b8f859911506..74a49a8fb33666d668c1a423e60f448d19d1b228 100644 (file)
@@ -1352,7 +1352,7 @@ The whole point of creating and populating an OptionParser is to call its
       the list of arguments to process (default: ``sys.argv[1:]``)
 
    ``values``
-      an :class:`Values` object to store option arguments in (default: a
+      a :class:`Values` object to store option arguments in (default: a
       new instance of :class:`Values`) -- if you give an existing object, the
       option defaults will not be initialized on it
 
index b93b06d4e72afca794c63d9b5be9f7f329b356c0..4aede7f902f5493d58e0fe69930d80d5d9de7c5d 100644 (file)
@@ -1551,7 +1551,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
 
 .. function:: pwritev(fd, buffers, offset, flags=0, /)
 
-   Write the *buffers* contents to file descriptor *fd* at a offset *offset*,
+   Write the *buffers* contents to file descriptor *fd* at an offset *offset*,
    leaving the file offset unchanged.  *buffers* must be a sequence of
    :term:`bytes-like objects <bytes-like object>`. Buffers are processed in
    array order. Entire contents of the first buffer is written before
@@ -3775,7 +3775,7 @@ features:
    new file descriptor is :ref:`non-inheritable <fd_inheritance>`.
 
    *initval* is the initial value of the event counter. The initial value
-   must be an 32 bit unsigned integer. Please note that the initial value is
+   must be a 32 bit unsigned integer. Please note that the initial value is
    limited to a 32 bit unsigned int although the event counter is an unsigned
    64 bit integer with a maximum value of 2\ :sup:`64`\ -\ 2.
 
@@ -3854,7 +3854,7 @@ features:
 
 .. data:: EFD_SEMAPHORE
 
-   Provide semaphore-like semantics for reads from a :func:`eventfd` file
+   Provide semaphore-like semantics for reads from an :func:`eventfd` file
    descriptor. On read the internal counter is decremented by one.
 
    .. availability:: Linux >= 2.6.30
index 6c3503a60e6e5e968af5b031b6908c1dfa33bde3..abf632159a94c03e59195fb82a1c98b69b7f9b76 100644 (file)
@@ -994,7 +994,7 @@ Querying file type and status
 
 .. method:: Path.stat(*, follow_symlinks=True)
 
-   Return a :class:`os.stat_result` object containing information about this path, like :func:`os.stat`.
+   Return an :class:`os.stat_result` object containing information about this path, like :func:`os.stat`.
    The result is looked up at each call to this method.
 
    This method normally follows symlinks; to stat a symlink add the argument
index 78b3c2697bd6968ae353e703d8b0361da596a775..2906ebe7822f525e4d6f774dd3cad9b2b36bd9fc 100644 (file)
@@ -117,7 +117,7 @@ This module defines the following functions:
    when a key of a dictionary is not a string, otherwise such keys are skipped.
 
    When *aware_datetime* is true and any field with type ``datetime.datetime``
-   is set as a :ref:`aware object <datetime-naive-aware>`, it will convert to
+   is set as an :ref:`aware object <datetime-naive-aware>`, it will convert to
    UTC timezone before writing it.
 
    A :exc:`TypeError` will be raised if the object is of an unsupported type or
index dc72f67c6361e20a03610c07c4c8cd46219e81f4..7d4c1f0f2de347ab26a89a3501313d58bc46357b 100644 (file)
@@ -1742,7 +1742,7 @@ to speed up repeated connections from the same clients.
    IDN-encoded internationalized domain name, the *server_name_callback*
    receives a decoded U-label (``"pythön.org"``).
 
-   If there is an decoding error on the server name, the TLS connection will
+   If there is a decoding error on the server name, the TLS connection will
    terminate with an :const:`ALERT_DESCRIPTION_INTERNAL_ERROR` fatal TLS
    alert message to the client.
 
index 3a2178e2b7b8395205f6ac23a5bbdfb296b754f7..82e152d2024377c7a0c7fdb113296db423513593 100644 (file)
@@ -1126,7 +1126,7 @@ The :mod:`subprocess` module exposes the following constants.
 .. data:: NORMAL_PRIORITY_CLASS
 
    A :class:`Popen` ``creationflags`` parameter to specify that a new process
-   will have an normal priority. (default)
+   will have a normal priority. (default)
 
    .. versionadded:: 3.7
 
index 754405e0fbe5b29befdf22af47733cabbfc3bed6..88c1f4bf85f662c5aa616aab5c90bbb4d2511aac 100644 (file)
@@ -1092,7 +1092,7 @@ FileHandler Objects
 
    .. versionchanged:: 3.2
       This method is applicable only for local hostnames.  When a remote
-      hostname is given, an :exc:`~urllib.error.URLError` is raised.
+      hostname is given, a :exc:`~urllib.error.URLError` is raised.
 
 
 .. _data-handler-objects:
@@ -1107,7 +1107,7 @@ DataHandler Objects
    ignores white spaces in base64 encoded data URLs so the URL may be wrapped
    in whatever source file it comes from. But even though some browsers don't
    mind about a missing padding at the end of a base64 encoded data URL, this
-   implementation will raise an :exc:`ValueError` in that case.
+   implementation will raise a :exc:`ValueError` in that case.
 
 
 .. _ftp-handler-objects:
index 5d0924be8d906db2cb79002bc7ffb49f3410335f..ad959064a0af48a5a6fbd70524d329f85757d585 100644 (file)
@@ -39,7 +39,7 @@ iOS version compatibility
 The minimum supported iOS version is specified at compile time, using the
 :option:`--host` option to ``configure``. By default, when compiled for iOS,
 Python will be compiled with a minimum supported iOS version of 13.0. To use a
-different miniumum iOS version, provide the version number as part of the
+different minimum iOS version, provide the version number as part of the
 :option:`!--host` argument - for example,
 ``--host=arm64-apple-ios15.4-simulator`` would compile an ARM64 simulator build
 with a deployment target of 15.4.