Mailman 3 September 2010 - docs

[issue6916] Remove deprecated items from asynchat
by Antoine Pitrou Sept. 3, 2010

Sept. 3, 2010

Changes by Antoine Pitrou <pitrou(a)free.fr>: ---------- assignee: josiahcarlson -> giampaolo.rodola stage: -> patch review versions: -Python 3.0, Python 3.1 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue6916> _______________________________________

1 0

[issue9760] Suggestion for improving with documentation
by Jason Baker Sept. 3, 2010

Sept. 3, 2010

New submission from Jason Baker <amnorvend(a)gmail.com>: http://docs.python.org/reference/compound_stmts.html#with This documentation refers to "context expressions" in two places. However, it never really defines what a context expression is. The formal syntax that's presented is this: with_stmt ::= "with" with_item ("," with_item)* ":" suite with_item ::= expression ["as" target] As best I can tell, the context expression is essentially the with_item. If that's the case, I propose one of the following: 1) The formal syntax is changed so that "with_item" becomes "context_expression". 2) References to "context expression" change to "with item". 3) The "context expression" is defined to be the with_item in the formal syntax at some point in the documentation. ---------- assignee: docs@python components: Documentation messages: 115478 nosy: Jason.Baker, docs@python priority: normal severity: normal status: open title: Suggestion for improving with documentation type: behavior versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9760> _______________________________________

2 1

[issue9739] Output of help(...) is wider than 80 characters
by Terry J. Reedy Sept. 3, 2010

Sept. 3, 2010

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: Although this is not a problem in IDLE where the window can easily be expanded beyond 80 chars, I am in favor of the idea for other uses. The command line interpreter on Windows defaults to 80 chars and is not so easy to change, and one must be admin to make the change 'permanent' (until the next install reverts the change). In particular, the 82 char line for math.trun results in 'd.' of 'method.' wrapped to a line by itself with no indent. Pretty ugly. However, I am puzzled why you edited the 74 char line for math.modf, which displays as 78 chars with a 4 char indent. This '''\ Return the fractional and integer parts of x. Both results carry the sign''' displays fine on one line as is. The tracker, unfortunately, displays 123456789012345678901234567890123456789012345678901234567890123456789012 only 72 chars. of x and are floats. I agree that trunc(x:Real) -> Integral is more helpful (and therefore better) than modf(x) For something like -"T.index(value, [start, [stop]]) -> integer -- return first index of value.\n" I personally think '->' and 'return are redundant, so I would argue that this could be shortened to -"T.index(value, [start, [stop]]) -> integer (first index of value).\n" instead of by wrapping. Since I am not yet in a position to apply patches, I am not (yet) in a position to tell you whether or how to produce more patches. ---------- nosy: +terry.reedy stage: -> patch review versions: +Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9739> _______________________________________

1 0

[issue9755] Fix refcounting details in Py3k C API documentation
by Skip Montanaro Sept. 3, 2010

Sept. 3, 2010

Skip Montanaro <skip(a)pobox.com> added the comment: I thought Fred Drake wrote the code that generated that file, but that was a long time ago in a galaxy far, far away. Perhaps Georg has subsumed it into his Sphinx/Python doc workflow? (making Fred "nosy" so he sees this thread...) S ---------- nosy: +fdrake, skip.montanaro _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9755> _______________________________________

1 0

[issue9755] Fix refcounting details in Py3k C API documentation
by Nick Coghlan Sept. 3, 2010

Sept. 3, 2010

Changes by Nick Coghlan <ncoghlan(a)gmail.com>: ---------- assignee: -> docs@python nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9755> _______________________________________

1 0

Documentation bug for Python 3.x
by Sean McKean Sept. 2, 2010

Sept. 2, 2010

Greetings, I found a one-letter-missing bug on the page < http://docs.python.org/py3k/reference/simple_stmts.html > . Near the end of "The import statement," there is text declaring "import" as "imprt." Context: "from ..subpkg2 imprt mod" : html character 69441 of 88220, byte 69454 of 88236

1 0

[issue9739] Output of help(...) is wider than 80 characters
by Case Van Horsen Sept. 2, 2010

Sept. 2, 2010

Case Van Horsen <casevh(a)gmail.com> added the comment: 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. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9739> _______________________________________

1 0

[issue9739] Output of help(...) is wider than 80 characters
by Giampaolo Rodola' Sept. 2, 2010

Sept. 2, 2010

Changes by Giampaolo Rodola' <g.rodola(a)gmail.com>: ---------- nosy: +giampaolo.rodola _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9739> _______________________________________

1 0

[issue9739] Output of help(...) is wider than 80 characters
by Amaury Forgeot d'Arc Sept. 2, 2010

Sept. 2, 2010

Amaury Forgeot d'Arc <amauryfa(a)gmail.com> added the comment: Aren't there tools that extract only the first line of help? ---------- assignee: -> docs@python components: +Documentation -Extension Modules nosy: +amaury.forgeotdarc, docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9739> _______________________________________

1 0

[issue9677] "Global Module Index" link dead
by Brett Cannon Sept. 1, 2010

Sept. 1, 2010

New submission from Brett Cannon <brett(a)python.org>: When you build the HTML docs the "Global Module Index" link does not work while the "modules" link in the upper-right corner does. ---------- assignee: docs@python components: Documentation messages: 114832 nosy: brett.cannon, docs@python priority: high severity: normal stage: needs patch status: open title: "Global Module Index" link dead versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9677> _______________________________________

3 2