Skip to content

Commit

Permalink
bpo-25415: Remove confusing sentence from IOBase docstrings (PR-31631)
Browse files Browse the repository at this point in the history
(cherry picked from commit cedd247)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
  • Loading branch information
miss-islington and slateny committed Mar 4, 2022
1 parent 7b5b429 commit bdce188
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 13 deletions.
11 changes: 4 additions & 7 deletions Doc/library/io.rst
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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`:
Expand Down
5 changes: 2 additions & 3 deletions Lib/_pyio.py
Expand Up @@ -338,8 +338,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
Expand Down Expand Up @@ -1845,7 +1844,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):
Expand Down
3 changes: 1 addition & 2 deletions Modules/_io/iobase.c
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion Modules/_io/textio.c
Expand Up @@ -50,7 +50,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 *
Expand Down

0 comments on commit bdce188

Please sign in to comment.