Author martin.panter
Recipients Claudiu.Popa, eric.araujo, eric.snow, ethan.furman, martin.panter, ncoghlan, python-dev, serhiy.storchaka, yselivanov
Date 2015-04-21.23:14:20
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1429658060.64.0.313406042402.issue15582@psf.upfronthosting.co.za>
In-reply-to
Content
My example was taken from a package that tends to “properly document” everything in separate documentation files, rather than in the source code. I don’t really think Python should dictate if and how one document their code based on what base classes they use, and pydoc is still useful with code that has no doc strings.

But if this is to be the way of the future, perhaps a warning in the “What’s New” page might be a good idea. The inspect.getdoc() documentation should probably also have a “Changed in version 3.5” warning.

I guess it would be less automatic, but maybe another option might have been to add an @inherit_docstring decorator, or some explicit way to say a particular API (re)implements an (abstract) API documented elsewhere.
History
Date User Action Args
2015-04-21 23:14:20martin.pantersetrecipients: + martin.panter, ncoghlan, eric.araujo, Claudiu.Popa, ethan.furman, python-dev, eric.snow, serhiy.storchaka, yselivanov
2015-04-21 23:14:20martin.pantersetmessageid: <1429658060.64.0.313406042402.issue15582@psf.upfronthosting.co.za>
2015-04-21 23:14:20martin.panterlinkissue15582 messages
2015-04-21 23:14:20martin.pantercreate