classification
Title: Enhance doc of os.stat_result
Type: Stage:
Components: Documentation Versions: Python 3.4, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, python-dev, vstinner, zach.ware
Priority: normal Keywords: patch

Created on 2014-06-20 09:18 by vstinner, last changed 2014-07-24 13:46 by zach.ware. This issue is now closed.

Files
File name Uploaded Description Edit
stat_result.patch vstinner, 2014-06-20 09:18 review
stat_result.patch zach.ware, 2014-06-20 13:17 review
Messages (6)
msg221080 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2014-06-20 09:18
Attached patch creates a stat_result class in the os documentation and complete the documentation of each field. It makes possible to link directly an attribute of this class in the documentation, which is useful for the new st_file_attributes (issue #21719) for example.
msg221086 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2014-06-20 13:17
Rietveld didn't like an escape code at the beginning of your patch; here's the last 12,039 bytes of it which will hopefully make Rietveld happy.
msg221087 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2014-06-20 13:38
> ...an escape code at the beginning of your patch...

Yeah, these days I suffer because of the issue #19884 (readline issue in Mercurial).
msg223825 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-07-24 10:44
New changeset 833325d45113 by Victor Stinner in branch '3.4':
Issue #21813: Enhance documentation of the os.stat_result class.
http://hg.python.org/cpython/rev/833325d45113

New changeset 5d70ac83d104 by Victor Stinner in branch 'default':
Issue #21813: Enhance documentation of the os.stat_result class.
http://hg.python.org/cpython/rev/5d70ac83d104
msg223826 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2014-07-24 10:45
Thanks Zachary Ware for your review. I'm not sure that I addressed all your comments, but I'm not interested to spend too much time on the documentation. Please open an issue if your saw other things that can be improved.
msg223834 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2014-07-24 13:46
The only comments you didn't address you were right not to (sorry for the noise about path_fd, I completely missed that it was just a link reference); what you committed looks fine to me.

Thanks for your work on this, it looks like a big improvement to me!
History
Date User Action Args
2014-07-24 13:46:46zach.waresetmessages: + msg223834
versions: + Python 3.4
2014-07-24 10:45:32vstinnersetstatus: open -> closed
resolution: fixed
messages: + msg223826
2014-07-24 10:44:38python-devsetnosy: + python-dev
messages: + msg223825
2014-06-20 13:38:48vstinnersetmessages: + msg221087
2014-06-20 13:17:49zach.waresetfiles: + stat_result.patch
nosy: + zach.ware
messages: + msg221086

2014-06-20 09:18:22vstinnercreate