Mailman 3 August 2013 - docs

[issue16827] Remove the relatively advanced content from section 2 in tutorial
by Ramchandra Apte 18 Sep '14

18 Sep '14

New submission from Ramchandra Apte: Most of the content in section 2 in the tutorial, http://docs.python.org/3/tutorial/interpreter.html , is relatively advanced and doesn't belong in, at least, the beginning of the tutorial. Only 2.1. Invoking the Interpreter, and 2.2.3. Source Code Encoding should be in section 2. The rest can be moved outside the tutorial, or in later portions. Thanks to Ezio Melotti for helping me overcome my laziness in filing this bug. ---------- assignee: docs@python components: Documentation messages: 178680 nosy: docs@python, ramchandra.apte priority: normal severity: normal status: open title: Remove the relatively advanced content from section 2 in tutorial _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16827> _______________________________________

9 14

[issue14824] reprlib documentation references string module
by Jasper St. Pierre 18 Sep '14

18 Sep '14

New submission from Jasper St. Pierre <jstpierre(a)mecheye.net>: http://docs.python.org/dev/library/reprlib.html """ Formatting methods for specific types are implemented as methods with a name based on the type name. In the method name, TYPE is replaced by string.join(string.split(type(obj).__name__, '_')). Dispatch to these methods is handled by repr1(). Type-specific methods which need to recursively format a value should call self.repr1(subobj, level - 1). """ Outstanding. ---------- assignee: docs@python components: Documentation messages: 160805 nosy: docs@python, magcius priority: normal severity: normal status: open title: reprlib documentation references string module versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14824> _______________________________________

5 8

[issue15418] 2to3 docs should mention setup.py fixes required to install compatible packages in Python 3
by anatoly techtonik 30 Aug '14

30 Aug '14

New submission from anatoly techtonik <techtonik(a)gmail.com>: http://docs.python.org/py3k/library/2to3.html should mention the practice of running 2to3 in setup.py for codebase compatible with both Python 2 and Python 3. ---------- assignee: docs@python components: Documentation messages: 166108 nosy: docs@python, techtonik priority: normal severity: normal status: open title: 2to3 docs should mention setup.py fixes required to install compatible packages in Python 3 versions: Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15418> _______________________________________

4 3

[issue13540] Document the Action API
by Jason R. Coombs 24 Aug '14

24 Aug '14

New submission from Jason R. Coombs <jaraco(a)jaraco.com>: In http://docs.python.org/dev/library/argparse.html#action, when describing an arbitrary action, the documentation states, "You can also specify an arbitrary action by passing an object that implements the Action API." This statement does not link to any documentation on the Action API and does not describe the API except to give an example. Furthermore, the example contradicts the description. The description says "pass an object" but the example passes a class. The documentation should clarify the text relating to the example and should document the expected interface for a custom action. ---------- assignee: docs@python components: Documentation messages: 148921 nosy: docs@python, jason.coombs priority: low severity: normal status: open title: Document the Action API type: behavior versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13540> _______________________________________

8 30

[issue15428] add "Name Collision" section to argparse docs
by Steven Bethard 07 Aug '14

07 Aug '14

New submission from Steven Bethard <steven.bethard(a)gmail.com>: Several bugs (e.g. Issue 15327 and Issue 15271) have been filed suggesting that people aren't really clear on how argparse handles argument name collisions or how they can get it to do what they want. I think these problems could probably be solved by a "Name Collision" section (or something like that) in the argparse documentation. It would give a few example problems and show how to resolve them. Some things to include: * What happens when two arguments have the same dest (Issue 15271), with solutions including action='append' or different dest= values combined with identical metavar= values. * What happens when a parser and a sub-parser share some of the same argument names (Issue 15327), with solutions including specifying different dest= values for the parser and sub-parser * A brief mention and cross-reference to the "conflict_handler" section. ---------- assignee: docs@python components: Documentation messages: 166185 nosy: bethard, docs@python priority: normal severity: normal status: open title: add "Name Collision" section to argparse docs versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15428> _______________________________________

3 3

[issue15759] "make suspicious" doesn't display instructions in case of failure
by Ezio Melotti 05 Aug '14

05 Aug '14

New submission from Ezio Melotti: I was running "make suspicious" in Doc/ and this was the output after finding 3 suspicious markups: writing output... [ 52%] library/inspect WARNING: [library/inspect:437] ":int" found in ">>> def foo(a, *, b:int, **kwargs):" WARNING: [library/inspect:437] ":int" found in "'(a, *, b:int, **kwargs)'" WARNING: [library/inspect:437] ":int" found in "'b:int'" writing output... [100%] whatsnew/index build finished with problems, 3 warnings. make: *** [build] Error 1 After figuring out how to mark these as false positives and adding the relevant entries to susp-ignored.csv, I ran "make suspicious" again, and got this useful message at the end: writing output... [100%] whatsnew/index build succeeded. Suspicious check complete; look for any errors in the above output or in build/suspicious /suspicious.csv. If all issues are false positives, append that file to tools/sphinxext/susp-ignored.csv. The problem is that this message should be displayed when there are failures, but it's not. Attached an attempt to fix the Makefile to avoid exiting in case of failures when the builder is "suspicious". Given that I'm not really familiar with makefiles, it probably doesn't make much sense. ---------- assignee: docs@python components: Documentation files: issue15759.diff keywords: patch messages: 168842 nosy: docs@python, eric.araujo, ezio.melotti, georg.brandl priority: normal severity: normal stage: patch review status: open title: "make suspicious" doesn't display instructions in case of failure type: behavior versions: Python 3.3 Added file: http://bugs.python.org/file26956/issue15759.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15759> _______________________________________

5 15

[issue18034] Last two entries in the programming FAQ are out of date (import related)
by R. David Murray 04 Aug '14

04 Aug '14

New submission from R. David Murray: The second to last talks about the __import__ quirk with out calling __import__ out as deprecated. The last uses the imp module for reload. ---------- assignee: docs@python components: Documentation messages: 189827 nosy: brett.cannon, docs@python, eric.snow, r.david.murray priority: normal severity: normal stage: needs patch status: open title: Last two entries in the programming FAQ are out of date (import related) type: behavior versions: Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18034> _______________________________________

5 8

[issue18588] timeit examples should be consistent
by Clay McClure 04 Aug '14

04 Aug '14

New submission from Clay McClure: The timeit module documentation includes examples of command-line and programmatic invocation, but the results between the two sets of examples don't agree. This patch brings the results into agreement with each other. ---------- keywords: +patch Added file: http://bugs.python.org/file31076/18588.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18588> _______________________________________

6 8

[issue12970] os.wlak() consider some symlinks as dirs instead of non-dirs
by Марк Коренберг 28 Jul '14

28 Jul '14

New submission from Марк Коренберг <socketpair(a)gmail.com>: Consider code: for (root, dirs, nondirs) in os.walk(path, followlinks=False): print (nondirs) This code will not print symlinks that refer to some dir. I think it is the bug. In other words: If followlinks is True, we should consider some symlinks as dirs. If not, any symlink is the non-dir. Patch included. Also, please fix documentation about this nuance. ---------- assignee: docs@python components: Documentation, Library (Lib) files: z.patch keywords: patch messages: 143965 nosy: docs@python, mmarkk priority: normal severity: normal status: open title: os.wlak() consider some symlinks as dirs instead of non-dirs type: behavior versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4 Added file: http://bugs.python.org/file23140/z.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12970> _______________________________________

7 9

[issue17709] http://docs.python.org/2.7/objects.inv doesn't support :func:`repr` or :exc:`Exception`
by Russell Stuart 23 Jul '14

23 Jul '14

New submission from Russell Stuart: .. topic:: http://docs.python.org/2.7/objects.inv doesn't support :func:`repr` or :exc:`Exception` A bug report for Python 2.7's docs. .. _intro: Bug === Running:: sphinx-build -c conf2.7 -n -b html -E . html Produces:: Running Sphinx v1.1.3 loading intersphinx inventory from http://docs.python.org/2.7/objects.inv... building [html]: targets for 1 source files that are out of date updating environment: 1 added, 0 changed, 0 removed reading sources... [100%] bug looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [100%] bug /home/rstuart/zzz/bug.rst:1: WARNING: py:exc reference target not found: Exception /home/rstuart/zzz/bug.rst:1: WARNING: py:func reference target not found: repr writing additional files... genindex search copying static files... done dumping search index... done dumping object inventory... done build succeeded, 2 warnings. Note the ``WARNING`` lines. They should not be there. Running:: sphinx-build -c conf3.2 -b html -n -E . html Produces:: Running Sphinx v1.1.3 loading intersphinx inventory from http://docs.python.org/3.2/objects.inv... building [html]: targets for 1 source files that are out of date updating environment: 1 added, 0 changed, 0 removed reading sources... [100%] bug looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [100%] bug writing additional files... genindex search copying static files... done dumping search index... done dumping object inventory... done build succeeded. I presume this means something is wrong with http://docs.python.org/2.7/objects.inv it downloads. ``conf2.7.py``: .. include:: conf2.7/conf.py :literal: ``conf3.2.py``: .. include:: conf3.2/conf.py :literal: ---------- assignee: docs@python components: Documentation files: bug.rst messages: 186697 nosy: docs@python, ras priority: normal severity: normal status: open title: http://docs.python.org/2.7/objects.inv doesn't support :func:`repr` or :exc:`Exception` versions: Python 2.7 Added file: http://bugs.python.org/file29794/bug.rst _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17709> _______________________________________

4 5