[Python-checkins] bpo-46157: fix typo in docs (GH-30237)

asvetlov webhook-mailer at python.org
Thu Dec 23 04:17:48 EST 2021


https://github.com/python/cpython/commit/71ef0b4c2b77195bb1adc42602549284f7ee9566
commit: 71ef0b4c2b77195bb1adc42602549284f7ee9566
branch: main
author: Kumar Aditya <59607654+kumaraditya303 at users.noreply.github.com>
committer: asvetlov <andrew.svetlov at gmail.com>
date: 2021-12-23T11:17:31+02:00
summary:

bpo-46157: fix typo in docs (GH-30237)

files:
M Doc/library/asyncio-eventloop.rst
M Doc/library/enum.rst
M Doc/library/json.rst
M Doc/library/os.rst
M Doc/library/poplib.rst
M Doc/library/tarfile.rst

diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index a3609d3925833..c25b3e80982ac 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -322,7 +322,7 @@ Creating Futures and Tasks
 
 .. method:: loop.create_future()
 
-   Create an :class:`asyncio.Future` object attached to the event loop.
+   Create a :class:`asyncio.Future` object attached to the event loop.
 
    This is the preferred way to create Futures in asyncio. This lets
    third-party event loops provide alternative implementations of
@@ -649,7 +649,7 @@ Creating network servers
    * *backlog* is the maximum number of queued connections passed to
      :meth:`~socket.socket.listen` (defaults to 100).
 
-   * *ssl* can be set to an :class:`~ssl.SSLContext` instance to enable
+   * *ssl* can be set to a :class:`~ssl.SSLContext` instance to enable
      TLS over the accepted connections.
 
    * *reuse_address* tells the kernel to reuse a local socket in
@@ -737,7 +737,7 @@ Creating network servers
    * *sock* is a preexisting socket object returned from
      :meth:`socket.accept <socket.socket.accept>`.
 
-   * *ssl* can be set to an :class:`~ssl.SSLContext` to enable SSL over
+   * *ssl* can be set to a :class:`~ssl.SSLContext` to enable SSL over
      the accepted connections.
 
    * *ssl_handshake_timeout* is (for an SSL connection) the time in seconds to
@@ -897,7 +897,7 @@ convenient.
 
    .. versionchanged:: 3.7
       Even though the method was always documented as a coroutine
-      method, before Python 3.7 it returned an :class:`Future`.
+      method, before Python 3.7 it returned a :class:`Future`.
       Since Python 3.7, this is an ``async def`` method.
 
 .. coroutinemethod:: loop.sock_connect(sock, address)
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
index 572048a255bf0..8bb19dcdf2b61 100644
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -177,7 +177,7 @@ Data Types
 
    .. method:: EnumType.__getitem__(cls, name)
 
-      Returns the Enum member in *cls* matching *name*, or raises an :exc:`KeyError`::
+      Returns the Enum member in *cls* matching *name*, or raises a :exc:`KeyError`::
 
         >>> Color['BLUE']
         Color.BLUE
diff --git a/Doc/library/json.rst b/Doc/library/json.rst
index 1810e04cc8349..510b0459bbb5a 100644
--- a/Doc/library/json.rst
+++ b/Doc/library/json.rst
@@ -159,7 +159,7 @@ Basic Usage
 
    If *check_circular* is false (default: ``True``), then the circular
    reference check for container types will be skipped and a circular reference
-   will result in an :exc:`RecursionError` (or worse).
+   will result in a :exc:`RecursionError` (or worse).
 
    If *allow_nan* is false (default: ``True``), then it will be a
    :exc:`ValueError` to serialize out of range :class:`float` values (``nan``,
@@ -432,7 +432,7 @@ Encoders and Decoders
 
    If *check_circular* is true (the default), then lists, dicts, and custom
    encoded objects will be checked for circular references during encoding to
-   prevent an infinite recursion (which would cause an :exc:`RecursionError`).
+   prevent an infinite recursion (which would cause a :exc:`RecursionError`).
    Otherwise, no such check takes place.
 
    If *allow_nan* is true (the default), then ``NaN``, ``Infinity``, and
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 8092397be650f..8e11c693c7c2e 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -2081,7 +2081,7 @@ features:
    directories you can set the umask before invoking :func:`makedirs`.  The
    file permission bits of existing parent directories are not changed.
 
-   If *exist_ok* is ``False`` (the default), an :exc:`FileExistsError` is
+   If *exist_ok* is ``False`` (the default), a :exc:`FileExistsError` is
    raised if the target directory already exists.
 
    .. note::
@@ -2357,7 +2357,7 @@ features:
 .. function:: rmdir(path, *, dir_fd=None)
 
    Remove (delete) the directory *path*.  If the directory does not exist or is
-   not empty, an :exc:`FileNotFoundError` or an :exc:`OSError` is raised
+   not empty, a :exc:`FileNotFoundError` or an :exc:`OSError` is raised
    respectively.  In order to remove whole directory trees,
    :func:`shutil.rmtree` can be used.
 
diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst
index 27202a168e7c1..2f993f990de01 100644
--- a/Doc/library/poplib.rst
+++ b/Doc/library/poplib.rst
@@ -121,7 +121,7 @@ POP3 Objects
 All POP3 commands are represented by methods of the same name, in lowercase;
 most return the response text sent by the server.
 
-An :class:`POP3` instance has the following methods:
+A :class:`POP3` instance has the following methods:
 
 
 .. method:: POP3.set_debuglevel(level)
diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst
index 6afb8397b7866..f5c49b0ac4f73 100644
--- a/Doc/library/tarfile.rst
+++ b/Doc/library/tarfile.rst
@@ -63,19 +63,19 @@ Some facts and figures:
    +------------------+---------------------------------------------+
    | ``'x'`` or       | Create a tarfile exclusively without        |
    | ``'x:'``         | compression.                                |
-   |                  | Raise an :exc:`FileExistsError` exception   |
+   |                  | Raise a :exc:`FileExistsError` exception    |
    |                  | if it already exists.                       |
    +------------------+---------------------------------------------+
    | ``'x:gz'``       | Create a tarfile with gzip compression.     |
-   |                  | Raise an :exc:`FileExistsError` exception   |
+   |                  | Raise a :exc:`FileExistsError` exception    |
    |                  | if it already exists.                       |
    +------------------+---------------------------------------------+
    | ``'x:bz2'``      | Create a tarfile with bzip2 compression.    |
-   |                  | Raise an :exc:`FileExistsError` exception   |
+   |                  | Raise a :exc:`FileExistsError` exception    |
    |                  | if it already exists.                       |
    +------------------+---------------------------------------------+
    | ``'x:xz'``       | Create a tarfile with lzma compression.     |
-   |                  | Raise an :exc:`FileExistsError` exception   |
+   |                  | Raise a :exc:`FileExistsError` exception    |
    |                  | if it already exists.                       |
    +------------------+---------------------------------------------+
    | ``'a' or 'a:'``  | Open for appending with no compression. The |



More information about the Python-checkins mailing list