Mailman 3 December 2015 - docs

[issue13562] Notes about module load path
by Nam Nguyen Oct. 22, 2019

Oct. 22, 2019

New submission from Nam Nguyen <bitsink(a)gmail.com>: A doc patch to remind Python embedder to set sys.path prior to Py_Initialize. This is to ensure a controlled module load path to work around these issues: http://bugs.python.org/issue12989 http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2008-5983 ---------- assignee: docs@python components: Documentation files: module.load.path.diff keywords: patch messages: 149071 nosy: Nam.Nguyen, docs@python priority: normal severity: normal status: open title: Notes about module load path type: feature request versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2 Added file: http://bugs.python.org/file23888/module.load.path.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13562> _______________________________________

4 6

[issue17894] Edits to descriptor howto
by Ned Batchelder Oct. 10, 2019

Oct. 10, 2019

New submission from Ned Batchelder: I find the explanations in the Descriptor howto to be difficult to understand. I took a stab at changing the first few sections to introduce the concepts in an easier-to-grasp style. Issue 12077 also covers a little bit of this. ---------- assignee: docs@python components: Documentation files: descriptor_howto.patch keywords: patch messages: 188289 nosy: docs@python, nedbat priority: normal severity: normal status: open title: Edits to descriptor howto versions: Python 3.4 Added file: http://bugs.python.org/file30111/descriptor_howto.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17894> _______________________________________

7 15

[issue13474] Mention of "-m" Flag Missing From Doc on Execution Model
by Eric Snow Sept. 12, 2019

Sept. 12, 2019

New submission from Eric Snow <ericsnowcurrently(a)gmail.com>: The doc on code execution[1] leaves out mention of the -m flag. Seems like it belongs there too. [1] Doc/reference/executionmodel.rst ---------- assignee: docs@python components: Documentation messages: 148288 nosy: docs@python, eric.snow priority: normal severity: normal status: open title: Mention of "-m" Flag Missing From Doc on Execution Model versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13474> _______________________________________

8 10

[issue9938] Documentation for argparse interactive use
by Jay T Sept. 12, 2019

Sept. 12, 2019

New submission from Jay T <jaytula(a)gmail.com>: I want to create a custom interactive shell where I continually do parse_args. Like the following: parser = argparse.ArgumentParser() command = raw_input() while(True): args = parser.parse_args(shlex.split(command)) # Do some magic stuff command = raw_input() The problem is that if I give it invalid input, it errors and exits with a help message. I learned from argparse-users group that you can override the exit method like the following: class MyParser(ArgumentParser): def exit(self, status=0, message=None): # do whatever you want here I would be nice to have this usage documented perhaps along with best practices for doing help messages in this scenario. ---------- assignee: docs@python components: Documentation messages: 117287 nosy: docs@python, jayt priority: normal severity: normal status: open title: Documentation for argparse interactive use type: feature request versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9938> _______________________________________

16 28

[issue25810] Python 3 documentation for eval is incorrect
by Andre Roberge Sept. 11, 2019

Sept. 11, 2019

New submission from Andre Roberge: The documentation for eval() indicates that it takes keyword arguments: eval(expression, globals=None, locals=None) However, that is incorrect, as indicated by the builtin help: >>> help(eval) Help on built-in function eval in module builtins: eval(...) eval(source[, globals[, locals]]) -> value ---------- assignee: docs@python components: Documentation messages: 255969 nosy: aroberge, docs@python priority: normal severity: normal status: open title: Python 3 documentation for eval is incorrect versions: Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25810> _______________________________________

12 23

[issue16438] Numeric operator predecence confusing
by Yongzhi Pan Sept. 11, 2019

Sept. 11, 2019

New submission from Yongzhi Pan: http://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-comp… "All numeric types (except complex) support the following operations, sorted by ascending priority." It list '-' after '+', '/' after '*'. That is to mean '-' has higher precedence than '+'. That is wrong, and is contradicting with here: http://docs.python.org/3/reference/expressions.html#summary This should be made clear. ---------- assignee: docs@python components: Documentation messages: 175163 nosy: docs@python, fossilet priority: normal severity: normal status: open title: Numeric operator predecence confusing versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16438> _______________________________________

13 23

[issue25461] Unclear language (the word ineffective) in the documentation for os.walk
by Bernt Røskar Brenna Sept. 10, 2019

Sept. 10, 2019

New submission from Bernt Røskar Brenna: At least for me (non-english speaker), the following is confusing: "Modifying dirnames when topdown is False is ineffective, because in bottom-up mode the directories in dirnames are generated before dirpath itself is generated." I suggest to replace "is ineffective" with "has no effect". Ineffective could also mean: "Has low performance", could it not? ---------- assignee: docs@python components: Documentation messages: 253338 nosy: Bernt.Røskar.Brenna, docs@python priority: normal severity: normal status: open title: Unclear language (the word ineffective) in the documentation for os.walk type: enhancement versions: Python 2.7, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25461> _______________________________________

9 23

[issue21018] [patch] added missing documentation about escaping characters for configparser
by Arun Persaud Sept. 10, 2019

Sept. 10, 2019

New submission from Arun Persaud: Couldn't find how to escape % and $ in the documentation, so I thought I add a short patch. ---------- assignee: docs@python components: Documentation files: mywork.patch keywords: patch messages: 214442 nosy: Arun.Persaud, docs@python priority: normal severity: normal status: open title: [patch] added missing documentation about escaping characters for configparser type: enhancement Added file: http://bugs.python.org/file34562/mywork.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21018> _______________________________________

8 16

[issue18576] Rename and document test.script_helper as test.support.script_helper
by Nick Coghlan Sept. 9, 2019

Sept. 9, 2019

New submission from Nick Coghlan: tests.script_helper provides various utilities for sensibly testing scripts in a subprocess. It isn't easy for CPython developers to discover, since it is isn't documented and the file is mixed in with actual tests in the main test directory. As discussed in #15494, it should be: 1. Moved from Lib/test/ to Lib/test/support (and imports in tests adjusted accordingly) 2. Documented in Doc/library/test.rst These changes should be made on both the 3.3 and default branches to avoid spurious merge conflicts. ---------- assignee: docs@python components: Documentation, Tests messages: 193819 nosy: docs@python, ncoghlan priority: normal severity: normal status: open title: Rename and document test.script_helper as test.support.script_helper type: enhancement versions: Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18576> _______________________________________

10 28

[issue20806] os.times document points to wrong section of non-Linux manual
by Geoffrey Spear Sept. 7, 2019

Sept. 7, 2019

New submission from Geoffrey Spear: The documentation for os.times directs the reader: "See the Unix manual page times(2) or the corresponding Windows Platform API documentation." However, the POSIX manual page in question is times(3P), and on OS X and BSD systems it's times(3). Falling back to "man times" without specifying a manual section also doesn't work, since this finds the bash builtin rather than the library function. ---------- assignee: docs@python components: Documentation messages: 212424 nosy: docs@python, geoffreyspear priority: normal severity: normal status: open title: os.times document points to wrong section of non-Linux manual versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20806> _______________________________________

6 13