[docs] [issue25461] Unclear language (the word ineffective) in the documentation for os.walk

Bernt Røskar Brenna report at bugs.python.org
Fri Oct 23 09:04:34 EDT 2015

Bernt Røskar Brenna added the comment:

A question/comment:

In this case (and there are probably other cases like it) - it seems to me that the docstring (in os.py) and the docs (in os.rst) are similar enough that the docstring from the code could be included in the docs (using Sphinx's autodoc).

What is the preferred way? Is there a reason to have it the way it is? I notice the .rst docs have some formatting applied, is it considered not OK to put formatting in docstrings?


Python tracker <report at bugs.python.org>

More information about the docs mailing list