[docs] Enhance doc of os.stat_result (issue 21813)

zachary.ware at gmail.com zachary.ware at gmail.com
Fri Jun 20 15:42:32 CEST 2014


I like it, just a few nits picked.


http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst
File Doc/library/os.rst (right):

http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst#newcode1883
Doc/library/os.rst:1883: :ref:`not following symlinks
<follow_symlinks>`.
This paragraph confuses me: path_fd is not a parameter, but specifying a
file descriptor has already been mentioned; follow_symlinks has already
been mentioned as well.  The dir_fd parameter hasn't been mentioned,
though.

http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst#newcode1892
Doc/library/os.rst:1892: posix.stat_result(st_mode=33188,
st_ino=7876932, st_dev=234881026,
Is this still accurate? On Windows, at least, stat_result reprs show
"os.stat_result" rather than "<platform os module name>.stat_result".

http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst#newcode1904
Doc/library/os.rst:1904: .. versionadded:: 3.3
Kind of late on this, but shouldn't this be a versionchanged rather than
versionadded?  The note on st_file_attributes probably should be, too.

http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst#newcode1951
Doc/library/os.rst:1951: .. st_atime
attribute::

http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst#newcode2043
Doc/library/os.rst:2043: Create of the file.
Creator

http://bugs.python.org/review/21813/diff/12221/Doc/whatsnew/3.5.rst
File Doc/whatsnew/3.5.rst (right):

http://bugs.python.org/review/21813/diff/12221/Doc/whatsnew/3.5.rst#newcode182
Doc/whatsnew/3.5.rst:182: * :class:`os.stat_result` now has a
:attr:`os.stat_result.st_file_attributes`
I'd rather hide the `os.stat_result` on st_file_attributes
(:attr:`~os.stat_result.st_file_attributes`) since the line starts with
'os.stat_result now has...'.

http://bugs.python.org/review/21813/


More information about the docs mailing list