[issue12716] Reorganize os docs for files/dirs/fds
New submission from Benjamin Peterson <benjamin@python.org>: Right now many of the os function docs are split up into "Files and directories" and "file descriptor operations". This means, for example, that fchmod() and fchmodat() are in a different section than chmod(). It would make more sense to organize the docs such that functions that do the same thing are right next to each other. ---------- assignee: docs@python components: Documentation keywords: easy messages: 141820 nosy: benjamin.peterson, docs@python priority: low severity: normal status: open title: Reorganize os docs for files/dirs/fds versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
Benjamin Peterson <benjamin@python.org> added the comment: Also, symbolic constants should be close to the functions they are used in. For example, open() flags shouldn't be in their own section. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
Éric Araujo <merwok@netwok.org> added the comment: +1 ---------- nosy: +eric.araujo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
Changes by Serhiy Storchaka <storchaka@gmail.com>: ---------- nosy: +storchaka _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
Changes by Axel Wegen <axel.wegen@googlemail.com>: ---------- nosy: +Axel.Wegen _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
Mike Hoy added the comment: I was attempting to create a patch for this but all I have is moving fchmod() below chmod(). I was unable to find fchmodat() in os.rst. And I need further clarification on
Also, symbolic constants should be close to the functions they are used >>in. For example, open() flags shouldn't be in their own section.
---------- keywords: +patch nosy: +mikehoy Added file: http://bugs.python.org/file26961/issue141820-function-fchmod.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
A.M. Kuchling added the comment: Mike Hoy: a later patch (http://bugs.python.org/issue14626) changed the API in the os module so that the wrappers for *at() functions went away; fchmod() now takes several different forms of argument and calls the correct function under the hood. ---------- nosy: +akuchling _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
Roundup Robot added the comment: New changeset 88edac3bc2fc by Andrew Kuchling in branch 'default': #12716: reorganize docs for os module a bit http://hg.python.org/cpython/rev/88edac3bc2fc ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
A.M. Kuchling added the comment: I didn't see any other constants that aren't close to the function they're used with. Can this issue be closed, or are there other changes to make? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
A.M. Kuchling added the comment: Closing this issue after a week. Mike Hoy: thanks for your patch. ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue12716> _______________________________________
participants (7)
-
A.M. Kuchling -
Axel Wegen
-
Benjamin Peterson
-
Mike Hoy
-
Roundup Robot
-
Serhiy Storchaka
-
Éric Araujo