Message286141
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. |
|
Date |
User |
Action |
Args |
2017-01-24 06:26:51 | emilyemorehouse | set | recipients:
+ emilyemorehouse, docs@python, xiang.zhang |
2017-01-24 06:26:51 | emilyemorehouse | set | messageid: <1485239211.2.0.368814326879.issue29341@psf.upfronthosting.co.za> |
2017-01-24 06:26:51 | emilyemorehouse | link | issue29341 messages |
2017-01-24 06:26:50 | emilyemorehouse | create | |
|