[issue17306] Improve the way abstract base classes are shown in help()

Raymond Hettinger added the comment: Closing this due to lack of interest. -- resolution: -> postponed stage: patch review -> resolved status: open -> closed ___ Python tracker

[issue17306] Improve the way abstract base classes are shown in help()

Change by Jackson Riley : -- pull_requests: +16771 stage: -> patch review pull_request: https://github.com/python/cpython/pull/17278 ___ Python tracker ___

[issue17306] Improve the way abstract base classes are shown in help()

Jackson Riley added the comment: Hi Raymond - here's a first attempt at adding class-level docstrings, based off the format of Sequence.__doc__. Apologies if some things are not well worded etc. It looks like all of the non-magic methods have docstrings already but if you think the magic

[issue17306] Improve the way abstract base classes are shown in help()

Jackson Riley added the comment: Hi Raymond, I'm working with Ben on the EnHackathon project (https://enhackathon.github.io/) and am planning on working on this issue. Is that alright? Please do say if there's anything extra wanted or if you have any guidance (this is my first time

[issue17306] Improve the way abstract base classes are shown in help()

Raymond Hettinger added the comment: Benjamin, are you still interested in working on this? -- ___ Python tracker ___ ___

[issue17306] Improve the way abstract base classes are shown in help()

Benjamin Edwards added the comment: Michael are you still interested in doing this, if not can I take it on? -- nosy: +benedwards14 ___ Python tracker ___

[issue17306] Improve the way abstract base classes are shown in help()

Michael Anckaert added the comment: I would be very interested and motivated to work on this. I'll start by taking a look at the pointers Raymond gave. If anyone can chime in with some more information / guidance that would be awesome. -- nosy: +michaelanckaert

[issue17306] Improve the way abstract base classes are shown in help()

Raymond Hettinger 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

[issue17306] Improve the way abstract base classes are shown in help()

Changes by Mark Lawrence breamore...@yahoo.co.uk: -- versions: +Python 3.5 -Python 3.4 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue17306 ___ ___

[issue17306] Improve the way abstract base classes are shown in help()

Changes by Phil Connell pconn...@gmail.com: -- nosy: +pconnell ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue17306 ___ ___ Python-bugs-list

[issue17306] Improve the way abstract base classes are shown in help()

Changes by Éric Araujo mer...@netwok.org: -- nosy: +eric.araujo versions: +Python 3.4 -Python 2.7 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue17306 ___

[issue17306] Improve the way abstract base classes are shown in help()

New submission from Raymond Hettinger: Start by adding docstrings to the colletions ABCs. Look at improving help() to clearly show the required abstract methods. -- assignee: rhettinger components: Documentation messages: 183107 nosy: rhettinger priority: normal severity: normal status: