Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation corrections for os module #46071

Closed
robinstocker mannequin opened this issue Jan 3, 2008 · 2 comments
Closed

Documentation corrections for os module #46071

robinstocker mannequin opened this issue Jan 3, 2008 · 2 comments
Assignees
@birkenfeld
Labels
docs Documentation in the Doc dir

Comments

@robinstocker
Copy link
Mannequin

robinstocker mannequin commented Jan 3, 2008

BPO 1730
Nosy @birkenfeld
Files
  • os-module-corrections.patch: Patch for os module corrections
    		•

    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 = 'https://github.com/birkenfeld'
closed_at = <Date 2008-01-05.19:44:34.797>
created_at = <Date 2008-01-03.21:32:00.426>
labels = ['docs']
title = 'Documentation corrections for os module'
updated_at = <Date 2008-01-05.19:44:34.796>
user = 'https://bugs.python.org/robinstocker'

    bugs.python.org fields:

    activity = <Date 2008-01-05.19:44:34.796>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2008-01-05.19:44:34.797>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2008-01-03.21:32:00.426>
creator = 'robin.stocker'
dependencies = []
files = ['9051']
hgrepos = []
issue_num = 1730
keywords = ['patch']
message_count = 2.0
messages = ['59160', '59318']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'robin.stocker']
pr_nums = []
priority = 'low'
resolution = 'accepted'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue1730'
versions = []
    @robinstocker
    Copy link
    Mannequin Author

    robinstocker mannequin commented Jan 3, 2008

    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.

    @robinstocker robinstocker mannequin added the docs Documentation in the Doc dir label Jan 3, 2008
    @birkenfeld
    Copy link
    Member

    Thanks, committed as r59744!

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @birkenfeld birkenfeld

    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @birkenfeld