Repository navigation
Document IO module #46782
Description
| BPO | 2530 |
|---|---|
| Nosy | @gvanrossum, @birkenfeld, @mark-summerfield, @benjaminp |
| Files |
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']
Activity
benjaminp commentedon Apr 1, 2008
The IO module currently has some docs strings but no official RST docs.
I'm willing to work on this.
birkenfeld commentedon Apr 5, 2008
Great!
benjaminp commentedon Apr 6, 2008
Attaching a draft.
birkenfeld commentedon Apr 6, 2008
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 commentedon Apr 6, 2008
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 commentedon Apr 8, 2008
Attaching an updated patch from a review Mark Summerfield.
birkenfeld commentedon Apr 9, 2008
Reviewed, changed a few things and committed as r62252. Thanks!
benjaminp commentedon Apr 9, 2008
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 commentedon Apr 9, 2008
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 commentedon Apr 10, 2008
When you remove the class from the method declaration, it shows up in
the html as io.write? Is this correct?
birkenfeld commentedon Apr 12, 2008
It isn't. I'll have to investigate this -- I have a feeling of déjà-bug...
birkenfeld commentedon Apr 13, 2008
Should be fixed now with the latest Sphinx revision.
benjaminp commentedon Apr 13, 2008
And I have fleshed out the doc strings and backported it to 2.6.