Emily Morehouse added the comment:

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.

----------
nosy: +emilyemorehouse

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue29341>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to