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 Bernt.Røskar.Brenna
Recipients Bernt.Røskar.Brenna, docs@python, ezio.melotti, python-dev, r.david.murray, vstinner
Date 2015-10-23.13:04:33
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1445605473.94.0.865181371832.issue25461@psf.upfronthosting.co.za>
In-reply-to
Content
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?
History
Date User Action Args
2015-10-23 13:04:33Bernt.Røskar.Brennasetrecipients: + Bernt.Røskar.Brenna, vstinner, ezio.melotti, r.david.murray, docs@python, python-dev
2015-10-23 13:04:33Bernt.Røskar.Brennasetmessageid: <1445605473.94.0.865181371832.issue25461@psf.upfronthosting.co.za>
2015-10-23 13:04:33Bernt.Røskar.Brennalinkissue25461 messages
2015-10-23 13:04:33Bernt.Røskar.Brennacreate