[Python-Dev] Best practice for documentation for std lib
python-dev at masklinn.net
Sun Sep 22 13:05:14 CEST 2013
On 2013-09-22, at 12:16 , Nick Coghlan wrote:
> It's a bit of a pain, and we do occasionally get bug reports where the
> docstrings get out of date, but it's the least bad of the currently
> available options.
Is it really less bad than allowing limited fine-grained use of autodoc?
Not necessarily class-level and definitely not module-level, but
function- and method-level autodoc could allow avoiding duplication and
make it clearer that the prose and docstrings are getting out of sync.
More information about the Python-Dev