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

Document IO module #46782

Closed
benjaminp opened this issue Apr 1, 2008 · 13 comments
Closed

Document IO module #46782

benjaminp opened this issue Apr 1, 2008 · 13 comments
Assignees
@benjaminp
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@benjaminp
Copy link
Contributor

BPO 2530
Nosy @gvanrossum, @birkenfeld, @mark-summerfield, @benjaminp
Files
  • io_doc.patch
  • io_doc2.patch
  • io_doc3.patch
    		•

    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/benjaminp'
closed_at = <Date 2008-04-09.18:41:43.099>
created_at = <Date 2008-04-01.20:41:46.934>
labels = ['type-feature', 'docs']
title = 'Document IO module'
updated_at = <Date 2008-04-13.12:30:52.246>
user = 'https://github.com/benjaminp'

    bugs.python.org fields:

    activity = <Date 2008-04-13.12:30:52.246>
actor = 'benjamin.peterson'
assignee = 'benjamin.peterson'
closed = True
closed_date = <Date 2008-04-09.18:41:43.099>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2008-04-01.20:41:46.934>
creator = 'benjamin.peterson'
dependencies = []
files = ['9963', '9965', '9989']
hgrepos = []
issue_num = 2530
keywords = ['patch']
message_count = 13.0
messages = ['64822', '64971', '65037', '65042', '65044', '65217', '65251', '65267', '65271', '65284', '65409', '65438', '65443']
nosy_count = 4.0
nosy_names = ['gvanrossum', 'georg.brandl', 'mark', 'benjamin.peterson']
pr_nums = []
priority = 'critical'
resolution = 'accepted'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue2530'
versions = ['Python 3.0']
    @benjaminp
    Copy link
    Contributor Author

    The IO module currently has some docs strings but no official RST docs.
    I'm willing to work on this.

    @benjaminp benjaminp self-assigned this Apr 1, 2008
    @benjaminp benjaminp added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Apr 1, 2008
    @birkenfeld
    Copy link
    Member

    Great!

    @benjaminp
    Copy link
    Contributor Author

    Attaching a draft.

    @birkenfeld
    Copy link
    Member

    Looks good already! I can't review the full text now, but can you move
    member documentation into the indented block for the class? (I know
    other documents don't do this, but this is a legacy and I'd like new
    documents to adopt this style.)

    Additionally, the function description style is inconsistent ("Flushes
    the stream" vs "Return this").

    @benjaminp
    Copy link
    Contributor Author

    Ok. attaching an improved patch. Do you think information about
    indenting classes and such can be added to the style guide? It'd be very
    helpful.

    @benjaminp
    Copy link
    Contributor Author

    Attaching an updated patch from a review Mark Summerfield.

    @birkenfeld
    Copy link
    Member

    Reviewed, changed a few things and committed as r62252. Thanks!

    @benjaminp
    Copy link
    Contributor Author

    Georg, I have a few questions:
    Just out of curiosity, what did you change? Are their markup things I
    missed or other things you're looking for that I just didn't get?

    Are we going to want to push some of this stuff back into the docstrings?

    Should I backport this to 2.6?

    Mark: It has been checked in.

    @birkenfeld
    Copy link
    Member

    Other than the "class.method" change you already noticed, I changed some
    "method"s to "attribute"s (since they are @Propertied in the source),
    removed parens in :meth:`` roles, moved the constructor description into
    the .. class block and did some spelling corrections.

    A backport to 2.6 would be great. If you also find time to put some
    docstrings in, very good.

    @benjaminp
    Copy link
    Contributor Author

    When you remove the class from the method declaration, it shows up in
    the html as io.write? Is this correct?

    @birkenfeld
    Copy link
    Member

    It isn't. I'll have to investigate this -- I have a feeling of déjà-bug...

    @birkenfeld
    Copy link
    Member

    Should be fixed now with the latest Sphinx revision.

    @benjaminp
    Copy link
    Contributor Author

    And I have fleshed out the doc strings and backported it to 2.6.

    @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

    @benjaminp benjaminp

    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @birkenfeld @benjaminp