This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author steven.daprano
Recipients gregory.p.smith, steven.daprano
Date 2022-01-11.22:10:12
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1641939012.46.0.539434665786.issue46349@roundup.psfhosted.org>
In-reply-to
Content
Many docstrings are only 1 line without being "See base class." And many docstrings are multiple lines while also referring the reader to see the parent class for further details. So this DWIM heuristic to guess whether or not to display a parent class docstring will have a lot of both false positives and false negatives.

The false negatives just revert to the status quo, but the false positives will be annoying.

I am leery of DWIM code. The reader should be capable of recognising that sort of message and calling up help for that class, so I think the benefit here is minimal and the failures common.

But if we do go ahead with this, I have a style issue.

At the moment, getdoc shadows `object`, for no good purpose. (I'm fine with shadowing builtins if there is a good reason.) This is a minor issue that is not worth fixing on its own, but if you do end up touching getdoc to implement this, could you please remove the unnecessary shadowing? If we can call the function "get *doc*" we can call the parameter *obj* :-)
History
Date User Action Args
2022-01-11 22:10:12steven.dapranosetrecipients: + steven.daprano, gregory.p.smith
2022-01-11 22:10:12steven.dapranosetmessageid: <1641939012.46.0.539434665786.issue46349@roundup.psfhosted.org>
2022-01-11 22:10:12steven.dapranolinkissue46349 messages
2022-01-11 22:10:12steven.dapranocreate