This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: os.chflags refers to stat constants, but the constants are not documented in the stat module
Type: behavior Stage: resolved
Components: None Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, godfryd, python-dev, r.david.murray
Priority: normal Keywords: patch

Created on 2011-01-24 19:41 by r.david.murray, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
documented-os_chflags-flags.diff godfryd, 2011-01-27 20:46 review
documented-os_chflags-flags-v2.diff godfryd, 2011-03-02 11:08 review
Messages (7)
msg126947 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2011-01-24 19:41
Title pretty much says it all.  The constants are there in the stat module, but they aren't documented.  When they are documented the mentions in the os.chflags entry can be turned into cross reference links.
msg127224 - (view) Author: Michal Nowikowski (godfryd) Date: 2011-01-27 20:46
I have prepared a patch that:
- documents flags for os.chflags function in stat module
- adds links for these flags os module to stat module.
msg128436 - (view) Author: Michal Nowikowski (godfryd) Date: 2011-02-12 05:46
Is this patch ok?
msg128446 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2011-02-12 15:38
Looks good to me.

I wonder if the existing example should be moved up above the description of the chmod flags, though.  This update puts it even farther away from the functions it is an example of.
msg129871 - (view) Author: Michal Nowikowski (godfryd) Date: 2011-03-02 11:08
Improved the patch:
- moved code example up, just below S_* functions list
msg130532 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-03-10 23:22
New changeset 4f9213d3858b by R David Murray in branch '3.1':
#10999: Add missing documentation for chflags constants to stat module docs
http://hg.python.org/cpython/rev/4f9213d3858b

New changeset de5d0b4f81c3 by R David Murray in branch '3.2':
Merge #10999 fix.
http://hg.python.org/cpython/rev/de5d0b4f81c3

New changeset 761e6e85d29e by R David Murray in branch 'default':
Merge #10999 fix.
http://hg.python.org/cpython/rev/761e6e85d29e

New changeset 515a81ca81ce by R David Murray in branch '2.7':
#10999: Add missing documentation for chflags constants to stat module docs
http://hg.python.org/cpython/rev/515a81ca81ce
msg130533 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2011-03-10 23:26
Thanks for the patch!
History
Date User Action Args
2022-04-11 14:57:11adminsetgithub: 55208
2011-03-10 23:26:40r.david.murraysetstatus: open -> closed
nosy: r.david.murray, docs@python, godfryd, python-dev
messages: + msg130533

resolution: fixed
stage: needs patch -> resolved
2011-03-10 23:22:42python-devsetnosy: + python-dev
messages: + msg130532
2011-03-02 11:08:49godfrydsetfiles: + documented-os_chflags-flags-v2.diff
nosy: r.david.murray, docs@python, godfryd
messages: + msg129871
2011-02-12 15:38:19r.david.murraysetnosy: r.david.murray, docs@python, godfryd
messages: + msg128446
2011-02-12 05:46:20godfrydsetnosy: r.david.murray, docs@python, godfryd
messages: + msg128436
2011-01-27 20:46:03godfrydsetfiles: + documented-os_chflags-flags.diff
nosy: r.david.murray, docs@python, godfryd
messages: + msg127224

components: + None
keywords: + patch
2011-01-27 18:51:32godfrydsetnosy: + godfryd
2011-01-24 19:41:11r.david.murraycreate