[issue2530] Document IO module

Benjamin Peterson <[EMAIL PROTECTED]> added the comment: And I have fleshed out the doc strings and backported it to 2.6. __ Tracker <[EMAIL PROTECTED]> __ _

[issue2530] Document IO module

Georg Brandl <[EMAIL PROTECTED]> added the comment: Should be fixed now with the latest Sphinx revision. __ Tracker <[EMAIL PROTECTED]> __ ___ Python-bug

[issue2530] Document IO module

Georg Brandl <[EMAIL PROTECTED]> added the comment: It isn't. I'll have to investigate this -- I have a feeling of déjà-bug... __ Tracker <[EMAIL PROTECTED]> __

[issue2530] Document IO module

Benjamin Peterson <[EMAIL PROTECTED]> added the comment: When you remove the class from the method declaration, it shows up in the html as io.write? Is this correct? __ Tracker <[EMAIL PROTECTED]>

[issue2530] Document IO module

Georg Brandl <[EMAIL PROTECTED]> added the comment: 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 so

[issue2530] Document IO module

Benjamin Peterson <[EMAIL PROTECTED]> added the comment: 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

[issue2530] Document IO module

Georg Brandl <[EMAIL PROTECTED]> added the comment: Reviewed, changed a few things and committed as r62252. Thanks! -- resolution: -> accepted status: open -> closed __ Tracker <[EMAIL PROTECTED]> __

[issue2530] Document IO module

Benjamin Peterson <[EMAIL PROTECTED]> added the comment: Attaching an updated patch from a review Mark Summerfield. Added file: http://bugs.python.org/file9989/io_doc3.patch __ Tracker <[EMAIL PROTECTED]> ___

[issue2530] Document IO module

Benjamin Peterson <[EMAIL PROTECTED]> added the comment: 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. Added file: http://bugs.python.org/file9965/io_doc2.patch __

[issue2530] Document IO module

Georg Brandl <[EMAIL PROTECTED]> added the comment: 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.) Addi

[issue2530] Document IO module

Benjamin Peterson <[EMAIL PROTECTED]> added the comment: Attaching a draft. -- keywords: +patch Added file: http://bugs.python.org/file9963/io_doc.patch __ Tracker <[EMAIL PROTECTED]> __ _

[issue2530] Document IO module

Georg Brandl <[EMAIL PROTECTED]> added the comment: Great! __ Tracker <[EMAIL PROTECTED]> __ ___ Python-bugs-list mailing list Unsubscribe: http://mail

[issue2530] Document IO module

New submission from Benjamin Peterson <[EMAIL PROTECTED]>: The IO module currently has some docs strings but no official RST docs. I'm willing to work on this. -- assignee: benjamin.peterson components: Documentation messages: 64822 nosy: benjamin.peterson, georg.brandl priority: critica