Author casevh
Recipients amaury.forgeotdarc, casevh, docs@python, giampaolo.rodola
Date 2010-09-03.03:25:48
SpamBayes Score 9.39065e-12
Marked as misclassified No
Message-id <1283484350.26.0.371901300111.issue9739@psf.upfronthosting.co.za>
In-reply-to
Content
According to PEP 7, the first line of the doc string should contain the signature of the function, then there should be a blank line, and then the rest of the doc string. There may be tools that extract the signature line. The patch just decreases the line length of the remaining lines of the doc string so they don't wrap when displayed on an 80 character wide terminal window.

For an example, look at the text for modf(...) in help(math).

I just noticed that the math module uses "modf(x)" for the signature line but PEP 7 recommends including the return type, say "modf(x) -> (frac, int)".

The simplest change would be to fix the wrapping issue and leave the signature line alone. It would be more effort to make all the doc strings PEP 7 compliant by standardizing the signature line to include the return type.

I'm willing to work through the standard library and create patches for either option.
History
Date User Action Args
2010-09-03 03:25:50casevhsetrecipients: + casevh, amaury.forgeotdarc, giampaolo.rodola, docs@python
2010-09-03 03:25:50casevhsetmessageid: <1283484350.26.0.371901300111.issue9739@psf.upfronthosting.co.za>
2010-09-03 03:25:48casevhlinkissue9739 messages
2010-09-03 03:25:48casevhcreate