os.chflags refers to stat constants, but the constants are not documented in the stat module

[bitdancer]

BPO	10999
Nosy	@bitdancer
Files	documented-os_chflags-flags.diff documented-os_chflags-flags-v2.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2011-03-10.23:26:40.653>
created_at = <Date 2011-01-24.19:41:11.114>
labels = ['type-bug']
title = 'os.chflags refers to stat constants, but the constants are not documented in the stat module'
updated_at = <Date 2011-03-10.23:26:40.652>
user = 'https://github.com/bitdancer'

bugs.python.org fields:

activity = <Date 2011-03-10.23:26:40.652>
actor = 'r.david.murray'
assignee = 'docs@python'
closed = True
closed_date = <Date 2011-03-10.23:26:40.653>
closer = 'r.david.murray'
components = ['None']
creation = <Date 2011-01-24.19:41:11.114>
creator = 'r.david.murray'
dependencies = []
files = ['20555', '20973']
hgrepos = []
issue_num = 10999
keywords = ['patch']
message_count = 7.0
messages = ['126947', '127224', '128436', '128446', '129871', '130532', '130533']
nosy_count = 4.0
nosy_names = ['r.david.murray', 'docs@python', 'godfryd', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue10999'
versions = []

[bitdancer]

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.

[godfryd]

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.

[godfryd]

Is this patch ok?

[bitdancer]

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.

[godfryd]

Improved the patch:

• moved code example up, just below S_* functions list

[python-dev]

New changeset 4f9213d3858b by R David Murray in branch '3.1':
bpo-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 bpo-10999 fix.
http://hg.python.org/cpython/rev/de5d0b4f81c3

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

New changeset 515a81ca81ce by R David Murray in branch '2.7':
bpo-10999: Add missing documentation for chflags constants to stat module docs
http://hg.python.org/cpython/rev/515a81ca81ce

[bitdancer]

Thanks for the patch!