[Patches] [ python-Patches-785752 ] Documentation for platform module

SourceForge.net noreply at sourceforge.net
Sun Oct 12 01:16:39 EDT 2003


Patches item #785752, was opened at 2003-08-08 23:05
Message generated for change (Comment added) made by bcannon
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=785752&group_id=5470

Category: Documentation
Group: Python 2.3
Status: Open
Resolution: None
Priority: 5
Submitted By: Bjorn Pettersen (bpettersen)
Assigned to: M.-A. Lemburg (lemburg)
Summary: Documentation for platform module

Initial Comment:
This is my first time writing module documentation so be 
gentle <wink>. Let me know if I did something wrong 
and I'll fix and resubmit (compiling the docs sounded like 
dark magic, so I skipped that part ;-)

-- bjorn

----------------------------------------------------------------------

>Comment By: Brett Cannon (bcannon)
Date: 2003-10-11 22:16

Message:
Logged In: YES 
user_id=357491

Ran the docs through texcheck.py and added spaces between 
function parameters.

It looks like it is pretty much just a copy and paste job from the 
docstrings, right, Bjorn?  If so then as long as Bjorn did his 
copying after 2003-08-05 when I committed some cleanup of the 
of the docstrings there is no need to check it for correctness in 
terms of grammar and such.

So if Bjorn can verify he copied and pasted the docs after my 
patch to platform.py I can commit this so Fred can work his LaTeX 
magic on it.

----------------------------------------------------------------------

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2003-08-14 20:18

Message:
Logged In: YES 
user_id=3066

Marc-Andre, could you please review these docs?
Thanks!

----------------------------------------------------------------------

Comment By: Brett Cannon (bcannon)
Date: 2003-08-11 00:26

Message:
Logged In: YES 
user_id=357491

If this patch gets accepted, please close bug #726911.

----------------------------------------------------------------------

Comment By: Martin v. Löwis (loewis)
Date: 2003-08-09 02:17

Message:
Logged In: YES 
user_id=21627

Thanks for this document. It currently does not follow the
grammatical conventions. Please use the imperative voice;
quoting from PEP 257

 It prescribes the function or method's effect as a command
("Do this", "Return that"), not as a description; e.g. don't
write "Returns the pathname ...".

In addition, please indicate where you suggest this
documentation to go in the table-of-contents, preferably by
means of a patch.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=785752&group_id=5470



More information about the Patches mailing list