[New-bugs-announce] [issue21225] io.py: Improve docstrings for classes

A.M. Kuchling report at bugs.python.org
Mon Apr 14 22:50:46 CEST 2014


New submission from A.M. Kuchling:

io.py contains the following to declare ABCs for some of its classes:

class IOBase(_io._IOBase, metaclass=abc.ABCMeta):
    pass

(and similarly for RawIOBase, BufferedIOBase, TextIOBase).

_io._IOBase has an extensive docstring, but IOBase doesn't. (Python doesn't inherit parent-class docstrings, on the theory that the subclass may change things that make the docstring invalid.)

I propose the attached patch.

----------
files: io-copy-docstrings.patch
keywords: easy, patch
messages: 216210
nosy: akuchling
priority: normal
severity: normal
stage: patch review
status: open
title: io.py: Improve docstrings for classes
type: enhancement
Added file: http://bugs.python.org/file34847/io-copy-docstrings.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue21225>
_______________________________________


More information about the New-bugs-announce mailing list