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: Documentation corrections for os module
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, robin.stocker
Priority: low Keywords: patch

Created on 2008-01-03 21:32 by robin.stocker, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
os-module-corrections.patch robin.stocker, 2008-01-03 21:31 Patch for os module corrections
Messages (2)
msg59160 - (view) Author: Robin Stocker (robin.stocker) Date: 2008-01-03 21:31
I saw a minor inconsistency in the documentation of the os module and
then somehow ended up proof-reading the whole file :). The result of
this is attached as a patch against trunk.

Summary of the changes:

- Use the imperative tense in method descriptions
- Some more links using semantic markup
- Added example for file.seek
- Consistently use "" instead of '' in text
- or-ed, OR'd replaced with ORed
- bit-wise replaced with bitwise

Diffstat for the patch::

 Doc/c-api/newtypes.rst        |    2 
 Doc/library/fcntl.rst         |    2 
 Doc/library/functions.rst     |    2 
 Doc/library/msvcrt.rst        |    2 
 Doc/library/os.rst            |  155
+++++++++++++++++++++---------------------
 Doc/library/stdtypes.rst      |    9 +-
 Doc/library/winsound.rst      |    2 
 Doc/reference/expressions.rst |   18 ++--
 Lib/test/test_doctest.py      |    2 
 Modules/fcntlmodule.c         |    2 
 10 files changed, 101 insertions(+), 95 deletions(-)

I hope the changes are ok.
msg59318 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-01-05 19:44
Thanks, committed as r59744!
History
Date User Action Args
2022-04-11 14:56:29adminsetgithub: 46071
2008-01-05 19:44:34georg.brandlsetstatus: open -> closed
resolution: accepted
messages: + msg59318
2008-01-03 22:20:16christian.heimessetpriority: low
assignee: georg.brandl
keywords: + patch
nosy: + georg.brandl
2008-01-03 21:32:00robin.stockercreate