[Python-ideas] inheriting docstrings and mutable docstings for classes

David Stanek dstanek at dstanek.com
Fri Jun 10 13:40:48 CEST 2011

On Fri, Jun 10, 2011 at 7:22 AM, Steven D'Aprano <steve at pearwood.info>wrote:

> David Stanek wrote:
>> How would a tool know if the behavior of a method changed without
>> analyzing
>> the code? I think this could very easily lead to a situation where a
>> project's generated documentation is incorrect.
> That's the developer's problem, and no different from any other case where
> you inherit data without ensuring it is the correct data.

This means that a significant amount of existing code may/will have problems
with this type of change. If Sphinx did this automatically I'm sure there
would be lots of incorrect documentation. I think the developer should
explicitly carry over and modify the documentation if necessary.

blog: http://www.traceback.org
twitter: http://twitter.com/dstanek
www: http://dstanek.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-ideas/attachments/20110610/45baa4a2/attachment.html>

More information about the Python-ideas mailing list