Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(29582)

#21813: Enhance doc of os.stat_result

Can't Edit
Can't Publish+Mail
Start Review
Created:
5 years, 3 months ago by vstinner
Modified:
5 years, 1 month ago
Reviewers:
zachary.ware
CC:
haypo, docs_python.org, devnull_psf.upfronthosting.co.za, Zach Ware
Visibility:
Public.

Patch Set 1 #

Patch Set 2 #

Total comments: 11
Unified diffs Side-by-side diffs Delta from patch set Stats Patch
Doc/library/os.rst View 1 5 chunks +197 lines, -91 lines 10 comments Download
Doc/whatsnew/3.5.rst View 1 1 chunk +2 lines, -5 lines 1 comment Download

Messages

Total messages: 2
Zach Ware
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 ...
5 years, 3 months ago #1
victor.stinner_gmail.com
5 years, 1 month ago #2
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>`.
On 2014/06/20 15:42:33, Zach Ware wrote:
> 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.

<path_fd> is used in a link to a different section of the documentation.

The dir_fd parameter is documented in the section pointed by path_fd:
https://docs.python.org/dev/library/os.html#files-and-directories

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,
On 2014/06/20 15:42:33, Zach Ware wrote:
> Is this still accurate? On Windows, at least, stat_result reprs show
> "os.stat_result" rather than "<platform os module name>.stat_result".

You're right, I changed it to os.stat_result().

http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst#newcode1904
Doc/library/os.rst:1904: .. versionadded:: 3.3
On 2014/06/20 15:42:33, Zach Ware wrote:
> 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.

This is unrelated to my change. I think that versionadded is correct. The result
in the HTML doc is "New in version 3.3: Added the ...". Open a new issue if you
want to change these notes.

http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst#newcode1951
Doc/library/os.rst:1951: .. st_atime
On 2014/06/20 15:42:33, Zach Ware wrote:
> attribute:: 

Done.

http://bugs.python.org/review/21813/diff/12221/Doc/library/os.rst#newcode2043
Doc/library/os.rst:2043: Create of the file.
On 2014/06/20 15:42:33, Zach Ware wrote:
> Creator

Done.
Sign in to reply to this message.

RSS Feeds Recent Issues | This issue
This is Rietveld 894c83f36cb7+