[issue17306] Improve the way abstract base classes are shown in help()
Raymond Hettinger
report at bugs.python.org
Thu Aug 22 03:20:06 EDT 2019
Raymond Hettinger <raymond.hettinger at gmail.com> added the comment:
There is just a little more work to do on this.
1) The class level docstrings needs to display which methods are required. Sequence.__doc__ already does a good job of this but most of the other classes are missing docstrings or don't specific the needed methods.
2) Methods like Sequence.count and Mapping.__eq__ already have a good docstrings but there is nothing for most of the other methods. The docstring should be modeled on that for the corresponding methods in the concrete classes (list.__getitem__ for example).
----------
keywords: +newcomer friendly
versions: +Python 3.8, Python 3.9 -Python 3.5
_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue17306>
_______________________________________
More information about the Python-bugs-list
mailing list