bpo-25415: Remove confusing sentence from IOBase docstrings (PR-31631)

This commit is contained in:
slateny 2022-03-04 09:35:52 -08:00 committed by GitHub
parent d168c728f7
commit cedd2473a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 13 deletions

View file

@ -306,8 +306,7 @@ I/O Base Classes
.. class:: IOBase
The abstract base class for all I/O classes, acting on streams of bytes.
There is no public constructor.
The abstract base class for all I/O classes.
This class provides empty abstract implementations for many methods
that derived classes can override selectively; the default
@ -461,8 +460,7 @@ I/O Base Classes
.. class:: RawIOBase
Base class for raw binary streams. It inherits :class:`IOBase`. There is no
public constructor.
Base class for raw binary streams. It inherits :class:`IOBase`.
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
@ -515,7 +513,7 @@ I/O Base Classes
.. class:: BufferedIOBase
Base class for binary streams that support some kind of buffering.
It inherits :class:`IOBase`. There is no public constructor.
It inherits :class:`IOBase`.
The main difference with :class:`RawIOBase` is that methods :meth:`read`,
:meth:`readinto` and :meth:`write` will try (respectively) to read as much
@ -852,8 +850,7 @@ Text I/O
.. class:: TextIOBase
Base class for text streams. This class provides a character and line based
interface to stream I/O. It inherits :class:`IOBase`. There is no public
constructor.
interface to stream I/O. It inherits :class:`IOBase`.
:class:`TextIOBase` provides or overrides these data attributes and
methods in addition to those from :class:`IOBase`:

View file

@ -326,8 +326,7 @@ class UnsupportedOperation(OSError, ValueError):
class IOBase(metaclass=abc.ABCMeta):
"""The abstract base class for all I/O classes, acting on streams of
bytes. There is no public constructor.
"""The abstract base class for all I/O classes.
This class provides dummy implementations for many methods that
derived classes can override selectively; the default implementations
@ -1833,7 +1832,7 @@ class TextIOBase(IOBase):
"""Base class for text I/O.
This class provides a character and line based interface to stream
I/O. There is no public constructor.
I/O.
"""
def read(self, size=-1):

View file

@ -34,8 +34,7 @@ typedef struct {
} iobase;
PyDoc_STRVAR(iobase_doc,
"The abstract base class for all I/O classes, acting on streams of\n"
"bytes. There is no public constructor.\n"
"The abstract base class for all I/O classes.\n"
"\n"
"This class provides dummy implementations for many methods that\n"
"derived classes can override selectively; the default implementations\n"

View file

@ -30,7 +30,7 @@ PyDoc_STRVAR(textiobase_doc,
"\n"
"This class provides a character and line based interface to stream\n"
"I/O. There is no readinto method because Python's character strings\n"
"are immutable. There is no public constructor.\n"
"are immutable.\n"
);
static PyObject *