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 emilyemorehouse
Recipients docs@python, emilyemorehouse, xiang.zhang
Date 2017-01-24.06:26:50
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1485239211.2.0.368814326879.issue29341@psf.upfronthosting.co.za>
In-reply-to
Content
I see that path-like objects are indeed mentioned in the documentation (Doc/library/os.rst), simply stating "Changed in version 3.6: Supports a path-like object." Other methods, such as os.chroot, also mention such a change.

Comparing the docs mentioned above to the docstrings in Modules/clinic/posixmodule.c.h (and Modules/clinic/posixmodule.c for that matter), there's a clear disparity between the detail in the docs vs brevity in the docstrings (specifically in reference to os.chroot). 

Therefore, my question is: how detailed should the docstrings be and how closely should they match Doc/library/os.rst? I can certainly update the docstrings accordingly.
History
Date User Action Args
2017-01-24 06:26:51emilyemorehousesetrecipients: + emilyemorehouse, docs@python, xiang.zhang
2017-01-24 06:26:51emilyemorehousesetmessageid: <1485239211.2.0.368814326879.issue29341@psf.upfronthosting.co.za>
2017-01-24 06:26:51emilyemorehouselinkissue29341 messages
2017-01-24 06:26:50emilyemorehousecreate