Skip to content

Commit

Permalink
[3.12] Docs: spelling and grammar fixes (pythonGH-122084) (python#122107
Browse files Browse the repository at this point in the history
)


(cherry picked from commit bc264ea)

Co-authored-by: Ville Skyttä <[email protected]>
Co-authored-by: Bénédikt Tran <[email protected]>
  • Loading branch information
3 people authored Jul 22, 2024
1 parent 9343c6d commit 71970d6
Show file tree
Hide file tree
Showing 19 changed files with 27 additions and 27 deletions.
4 changes: 2 additions & 2 deletions Doc/c-api/init_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,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.
Expand Down Expand Up @@ -1000,7 +1000,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.
Expand Down
2 changes: 1 addition & 1 deletion Doc/howto/logging-cookbook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/ast.rst
Original file line number Diff line number Diff line change
Expand Up @@ -879,7 +879,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.

Expand Down Expand Up @@ -2002,7 +2002,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::

Expand Down
6 changes: 3 additions & 3 deletions Doc/library/asyncio-future.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/asyncio-task.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1104,7 +1104,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()

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/contextlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/ctypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/fractions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/http.server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/importlib.resources.abc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/importlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/inspect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,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.


.. function:: isasyncgen(object)
Expand Down Expand Up @@ -909,7 +909,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

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/mailbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1278,7 +1278,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.


Expand Down
2 changes: 1 addition & 1 deletion Doc/library/optparse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1351,7 +1351,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

Expand Down
6 changes: 3 additions & 3 deletions Doc/library/os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1497,7 +1497,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
Expand Down Expand Up @@ -3701,7 +3701,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.

Expand Down Expand Up @@ -3780,7 +3780,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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/pathlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -907,7 +907,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
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/ssl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1697,7 +1697,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.

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/subprocess.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1110,7 +1110,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

Expand Down
4 changes: 2 additions & 2 deletions Doc/library/urllib.request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1103,7 +1103,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:
Expand All @@ -1118,7 +1118,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:
Expand Down

0 comments on commit 71970d6

Please sign in to comment.