mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[3.11] Correct description of inheriting from another class (GH-114660) (#114869) 

"inherits <someclass>" grates to this reader. I think it should be "inherits from <someclass>".
(cherry picked from commit c9c6e04380)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
This commit is contained in:
Miss Islington (bot) 2024-02-01 19:15:12 +01:00 committed by GitHub
parent 3acab9a676
commit a46fddfed3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Doc/library/gzip.rst
View File

@ -61,7 +61,7 @@ The module defines the following items:
.. exception:: BadGzipFile .. exception:: BadGzipFile
An exception raised for invalid gzip files. It inherits :exc:`OSError`. An exception raised for invalid gzip files. It inherits from :exc:`OSError`.
:exc:`EOFError` and :exc:`zlib.error` can also be raised for invalid gzip :exc:`EOFError` and :exc:`zlib.error` can also be raised for invalid gzip
files. files.
@ -283,4 +283,3 @@ Command line options
.. option:: -h, --help .. option:: -h, --help
Show the help message. Show the help message.

24
Doc/library/io.rst
View File

@ -466,7 +466,7 @@ I/O Base Classes
.. class:: RawIOBase .. class:: RawIOBase
Base class for raw binary streams. It inherits :class:`IOBase`. Base class for raw binary streams. It inherits from :class:`IOBase`.
Raw binary streams typically provide low-level access to an underlying OS Raw binary streams typically provide low-level access to an underlying OS
device or API, and do not try to encapsulate it in high-level primitives device or API, and do not try to encapsulate it in high-level primitives
@ -519,7 +519,7 @@ I/O Base Classes
.. class:: BufferedIOBase .. class:: BufferedIOBase
Base class for binary streams that support some kind of buffering. Base class for binary streams that support some kind of buffering.
It inherits :class:`IOBase`. It inherits from :class:`IOBase`.
The main difference with :class:`RawIOBase` is that methods :meth:`read`, The main difference with :class:`RawIOBase` is that methods :meth:`read`,
:meth:`readinto` and :meth:`write` will try (respectively) to read as much :meth:`readinto` and :meth:`write` will try (respectively) to read as much
@ -633,7 +633,7 @@ Raw File I/O
.. class:: FileIO(name, mode='r', closefd=True, opener=None) .. class:: FileIO(name, mode='r', closefd=True, opener=None)
A raw binary stream representing an OS-level file containing bytes data. It A raw binary stream representing an OS-level file containing bytes data. It
inherits :class:`RawIOBase`. inherits from :class:`RawIOBase`.
The *name* can be one of two things: The *name* can be one of two things:
@ -696,7 +696,7 @@ than raw I/O does.
.. class:: BytesIO(initial_bytes=b'') .. class:: BytesIO(initial_bytes=b'')
A binary stream using an in-memory bytes buffer. It inherits A binary stream using an in-memory bytes buffer. It inherits from
:class:`BufferedIOBase`. The buffer is discarded when the :class:`BufferedIOBase`. The buffer is discarded when the
:meth:`~IOBase.close` method is called. :meth:`~IOBase.close` method is called.
@ -745,7 +745,7 @@ than raw I/O does.
.. class:: BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE) .. class:: BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE)
A buffered binary stream providing higher-level access to a readable, non A buffered binary stream providing higher-level access to a readable, non
seekable :class:`RawIOBase` raw binary stream. It inherits seekable :class:`RawIOBase` raw binary stream. It inherits from
:class:`BufferedIOBase`. :class:`BufferedIOBase`.
When reading data from this object, a larger amount of data may be When reading data from this object, a larger amount of data may be
@ -783,7 +783,7 @@ than raw I/O does.
.. class:: BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE) .. class:: BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE)
A buffered binary stream providing higher-level access to a writeable, non A buffered binary stream providing higher-level access to a writeable, non
seekable :class:`RawIOBase` raw binary stream. It inherits seekable :class:`RawIOBase` raw binary stream. It inherits from
:class:`BufferedIOBase`. :class:`BufferedIOBase`.
When writing to this object, data is normally placed into an internal When writing to this object, data is normally placed into an internal
@ -818,7 +818,7 @@ than raw I/O does.
.. class:: BufferedRandom(raw, buffer_size=DEFAULT_BUFFER_SIZE) .. class:: BufferedRandom(raw, buffer_size=DEFAULT_BUFFER_SIZE)
A buffered binary stream providing higher-level access to a seekable A buffered binary stream providing higher-level access to a seekable
:class:`RawIOBase` raw binary stream. It inherits :class:`BufferedReader` :class:`RawIOBase` raw binary stream. It inherits from :class:`BufferedReader`
and :class:`BufferedWriter`. and :class:`BufferedWriter`.
The constructor creates a reader and writer for a seekable raw stream, given The constructor creates a reader and writer for a seekable raw stream, given
@ -834,7 +834,7 @@ than raw I/O does.
A buffered binary stream providing higher-level access to two non seekable A buffered binary stream providing higher-level access to two non seekable
:class:`RawIOBase` raw binary streams---one readable, the other writeable. :class:`RawIOBase` raw binary streams---one readable, the other writeable.
It inherits :class:`BufferedIOBase`. It inherits from :class:`BufferedIOBase`.
*reader* and *writer* are :class:`RawIOBase` objects that are readable and *reader* and *writer* are :class:`RawIOBase` objects that are readable and
writeable respectively. If the *buffer_size* is omitted it defaults to writeable respectively. If the *buffer_size* is omitted it defaults to
@ -857,7 +857,7 @@ Text I/O
.. class:: TextIOBase .. class:: TextIOBase
Base class for text streams. This class provides a character and line based Base class for text streams. This class provides a character and line based
interface to stream I/O. It inherits :class:`IOBase`. interface to stream I/O. It inherits from :class:`IOBase`.
:class:`TextIOBase` provides or overrides these data attributes and :class:`TextIOBase` provides or overrides these data attributes and
methods in addition to those from :class:`IOBase`: methods in addition to those from :class:`IOBase`:
@ -946,7 +946,7 @@ Text I/O
line_buffering=False, write_through=False) line_buffering=False, write_through=False)
A buffered text stream providing higher-level access to a A buffered text stream providing higher-level access to a
:class:`BufferedIOBase` buffered binary stream. It inherits :class:`BufferedIOBase` buffered binary stream. It inherits from
:class:`TextIOBase`. :class:`TextIOBase`.
*encoding* gives the name of the encoding that the stream will be decoded or *encoding* gives the name of the encoding that the stream will be decoded or
@ -1073,7 +1073,7 @@ Text I/O
.. class:: StringIO(initial_value='', newline='\n') .. class:: StringIO(initial_value='', newline='\n')
A text stream using an in-memory text buffer. It inherits A text stream using an in-memory text buffer. It inherits from
:class:`TextIOBase`. :class:`TextIOBase`.
The text buffer is discarded when the :meth:`~IOBase.close` method is The text buffer is discarded when the :meth:`~IOBase.close` method is
@ -1124,7 +1124,7 @@ Text I/O
.. class:: IncrementalNewlineDecoder .. class:: IncrementalNewlineDecoder
A helper codec that decodes newlines for :term:`universal newlines` mode. A helper codec that decodes newlines for :term:`universal newlines` mode.
It inherits :class:`codecs.IncrementalDecoder`. It inherits from :class:`codecs.IncrementalDecoder`.
Performance Performance

6
Doc/library/pickle.rst
View File

@ -272,13 +272,13 @@ The :mod:`pickle` module defines three exceptions:
.. exception:: PickleError .. exception:: PickleError
Common base class for the other pickling exceptions. It inherits Common base class for the other pickling exceptions. It inherits from
:exc:`Exception`. :exc:`Exception`.
.. exception:: PicklingError .. exception:: PicklingError
Error raised when an unpicklable object is encountered by :class:`Pickler`. Error raised when an unpicklable object is encountered by :class:`Pickler`.
It inherits :exc:`PickleError`. It inherits from :exc:`PickleError`.
Refer to :ref:`pickle-picklable` to learn what kinds of objects can be Refer to :ref:`pickle-picklable` to learn what kinds of objects can be
pickled. pickled.
@ -286,7 +286,7 @@ The :mod:`pickle` module defines three exceptions:
.. exception:: UnpicklingError .. exception:: UnpicklingError
Error raised when there is a problem unpickling an object, such as a data Error raised when there is a problem unpickling an object, such as a data
corruption or a security violation. It inherits :exc:`PickleError`. corruption or a security violation. It inherits from :exc:`PickleError`.
Note that other exceptions may also be raised during unpickling, including Note that other exceptions may also be raised during unpickling, including
(but not necessarily limited to) AttributeError, EOFError, ImportError, and (but not necessarily limited to) AttributeError, EOFError, ImportError, and

4
Doc/library/symtable.rst
View File

@ -87,7 +87,7 @@ Examining Symbol Tables
.. class:: Function .. class:: Function
A namespace for a function or method. This class inherits A namespace for a function or method. This class inherits from
:class:`SymbolTable`. :class:`SymbolTable`.
.. method:: get_parameters() .. method:: get_parameters()
@ -113,7 +113,7 @@ Examining Symbol Tables
.. class:: Class .. class:: Class
A namespace of a class. This class inherits :class:`SymbolTable`. A namespace of a class. This class inherits from :class:`SymbolTable`.
.. method:: get_methods() .. method:: get_methods()