Mailman 3 August 2012 - docs

[issue15151] Documentation for Signature, Parameter and signature in inspect module
by Nick Coghlan 13 Aug '12

13 Aug '12

New submission from Nick Coghlan <ncoghlan(a)gmail.com>: The PEP 362 implementation has been committed, but the inspect module documentation still needs to be updated. ---------- assignee: docs@python components: Documentation messages: 163534 nosy: docs@python, ncoghlan priority: deferred blocker severity: normal status: open title: Documentation for Signature, Parameter and signature in inspect module versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________

7 18

[issue10224] Build 3.x documentation using python3.x
by Andrew Svetlov 13 Aug '12

13 Aug '12

Changes by Andrew Svetlov <andrew.svetlov(a)gmail.com>: ---------- nosy: +asvetlov _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10224> _______________________________________

1 0

[issue15638] incorrect version info for TextIOWrapper write_through docs
by Chris Jerdonek 13 Aug '12

13 Aug '12

New submission from Chris Jerdonek: The io.TextIOWrapper documentation says that the write_through argument was added in version 3.3: "Changed in version 3.3: The write_through argument has been added." http://docs.python.org/dev/library/io.html#io.TextIOWrapper However, it seems to be present in 3.2. Also, the 3.2 documentation does not mention the write_through argument. ---------- assignee: docs@python components: Documentation keywords: easy messages: 168092 nosy: asvetlov, cjerdonek, docs@python priority: normal severity: normal stage: needs patch status: open title: incorrect version info for TextIOWrapper write_through docs versions: Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15638> _______________________________________

3 5

[issue15555] Default newlines of io.TextIOWrapper
by Atsuo Ishimoto 13 Aug '12

13 Aug '12

New submission from Atsuo Ishimoto: In http://docs.python.org/dev/library/io.html: "if newline is None, any '\n' characters written are translated to the system default line separator, os.linesep. " But os.linesep is not referred at all. On Windows default newline is always '\r\n' on Windows, '\n' otherwise. ---------- assignee: docs@python components: Documentation messages: 167413 nosy: docs@python, ishimoto priority: normal severity: normal status: open title: Default newlines of io.TextIOWrapper _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15555> _______________________________________

4 5

[issue15624] clarify io.TextIOWrapper newline documentation
by Chris Jerdonek 13 Aug '12

13 Aug '12

New submission from Chris Jerdonek: The documentation of io.TextIOWrapper's newline argument is somewhat confusing and perhaps reversed from what was intended. (For example, the subprocess module uses the reverse terminology.) Either way, it can be improved somewhat. Currently, it says-- "* On input, if newline is None,... Lines in the input can end in '\n', '\r', or '\r\n', and these are translated into '\n' before being returned to the caller... * On output, if newline is None, any '\n' characters written are translated to the system default line separator, os.linesep..." (from http://docs.python.org/dev/library/io.html#io.TextIOWrapper ) It is somewhat confusing because "On input" does not mean "On input to the buffer," and "On output" does not mean "On output from the buffer." It is the reverse. A minimal change to address this would be something along the lines of-- "On input" -> "When reading input from the buffer" "On output" -> "When writing output to the buffer The same change could also be made to the open() documentation: http://docs.python.org/dev/library/functions.html#open I can prepare a patch for affected versions. ---------- assignee: docs@python components: Documentation keywords: easy messages: 167995 nosy: cjerdonek, docs@python priority: normal severity: normal status: open title: clarify io.TextIOWrapper newline documentation _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15624> _______________________________________

3 6

[issue15630] Missing "continue" example for "for" loop tutorial
by Daniel Ellis 12 Aug '12

12 Aug '12

New submission from Daniel Ellis: Found by Jesse Bikman: On this page, http://docs.python.org/tutorial/controlflow.html there is no example in the code of a "continue" statement (section 4.4). It is explained, but not actually used in code. ---------- assignee: docs@python components: Documentation messages: 168049 nosy: Daniel.Ellis, docs@python priority: normal severity: normal status: open title: Missing "continue" example for "for" loop tutorial _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15630> _______________________________________

5 6

[issue15628] Add import ABC hierarchy to docs for importlib
by Arfrever Frehtes Taifersar Arahesis 12 Aug '12

12 Aug '12

Changes by Arfrever Frehtes Taifersar Arahesis <Arfrever.FTA(a)GMail.Com>: ---------- nosy: +Arfrever _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15628> _______________________________________

1 0

Incorrect web docs for cgi.parse
by Aaron Bingham 12 Aug '12

12 Aug '12

The web docs at http://docs.python.org/library/cgi.html give an incorrect signature for cgi.parse. The environ argument is missing. cgi.parse(fp[, keep_blank_values[, strict_parsing]]) Parse a query in the environment or from a file (the file defaults to sys.stdin). The keep_blank_values and strict_parsing parameters are passed to urlparse.parse_qs() unchanged. The docstring is correct. >>> import cgi >>> help(cgi.parse) Help on function parse in module cgi: parse(fp=None, environ={}, keep_blank_values=0, strict_parsing=0) Parse a query in the environment or from a file (default stdin) Arguments, all optional: fp : file pointer; default: sys.stdin environ : environment dictionary; default: os.environ keep_blank_values: flag indicating whether blank values in URL encoded forms should be treated as blank strings. A true value indicates that blanks should be retained as blank strings. The default false value indicates that blank values are to be ignored and treated as if they were not included. strict_parsing: flag indicating what to do with parsing errors. If false (the default), errors are silently ign Cheers, -- Aaron Bingham / Software Engineer / bingham(a)google.com / +41 (44) 668 1380 Google Switzerland GmbH / Brandschenkestrasse 110 / CH-8002 Zurich / Switzerland Identifikationsnummer: CH-020.4.028.116-1

2 1

Missing example from code
by Jesse Bikman 12 Aug '12

12 Aug '12

Hi, On this page, http://docs.python.org/tutorial/controlflow.html there is no example in the code of a "continue" statement (section 4.4). It is explained, but not actually used in code. It would be simple to include, I think. Hope this helps! -- Jesse Bikman Department of Marine Science Graduate Student/Graduate Teaching Assistant Luettich lab University of North Carolina at Chapel Hill LinkedIn

2 1

Suggestion on docs for webbrowser
by Christian Clauss 12 Aug '12

12 Aug '12

On http://docs.python.org/library/webbrowser.html There is the text: The script webbrowser can be used as a command-line interface for the module. It accepts an URL as the argument. It accepts the following optional parameters: -n opens the URL in a new browser window, if possible; -t opens the URL in a new browser page (“tab”). The options are, naturally, mutually exclusive. It might be helpful to readers if you could add some sample syntax such as: $ python -m webbrowser -t "http://www.python.org"

2 1