Mailman 3 November 2015 - docs

[issue24027] IMAP library lacks documentation about expected parameter types
by Pablo 21 Apr '18

21 Apr '18

New submission from Pablo: I used the IMAP library and I feel it lacks a lot of documentation regarding types and encoding. Example: IMAP4.list([directory[, pattern]]): It doesn't state if it expects the directory argument to be an string (unicode) or a imap_utf7 encoded string or bytes. It also expects names with spaces to be between double quotation marks and it doesn't state that it returns a bytes raw output. This is valid for every function that receives a directory or mailbox argument. Also for most return values. Documentation aside, I think it would be a nice improvement in the implementation to add an imap_utf7 convertion function, and check every directory or mailbox argument to see if it has characters outside the imap_utf7 charset and attempts to convert them automatically. ---------- assignee: docs@python components: Documentation messages: 241812 nosy: docs@python, pmoleri priority: normal severity: normal status: open title: IMAP library lacks documentation about expected parameter types type: enhancement versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24027> _______________________________________

3 2

[issue13677] correct docstring for builtin compile
by Jim Jewett 22 Mar '18

22 Mar '18

New submission from Jim Jewett <jimjjewett(a)gmail.com>: The current docstring for compile suggests that the flags are strictly for selecting future statements. These are not the only flags. It also suggests that the source must be source code and the result will be bytecode, which isn't quite true. I suggest changing: "The flags argument, if present, controls which future statements influence the compilation of the code." to: "The flags argument, if present, largely controls which future statements influence the compilation of the code. (Additional flags are documented in the AST module.)" ---------- assignee: docs@python components: Documentation files: bltinmodule.c.patch keywords: patch messages: 150337 nosy: Jim.Jewett, docs@python priority: normal severity: normal status: open title: correct docstring for builtin compile type: behavior Added file: http://bugs.python.org/file24105/bltinmodule.c.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13677> _______________________________________

4 6

[issue21611] int() docstring - unclear what number is
by Dmitry Andreychuk 16 Mar '18

16 Mar '18

New submission from Dmitry Andreychuk: https://docs.python.org/3.4/library/functions.html?highlight=int#int The docstring for int() function has these sentences: "If x is a number, return x.__int__()." "If x is not a number or if base is given..." Unfortunately the docstring doesn't describe how the function decides if x is a number or not. After searching and experimenting I came to conclusion that it is the presence of x.__int__() method makes int() treat x as a number. But I'm not sure it's a precise requirement or just something that happens to work with current implementation. I think there should be a precise definition of what is considered to be a number there. ---------- assignee: docs@python components: Documentation messages: 219379 nosy: and, docs@python priority: normal severity: normal status: open title: int() docstring - unclear what number is versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21611> _______________________________________

7 9

[issue22822] IPv6Network constructor docs incorrect about valid input
by Chris PeBenito 08 Mar '18

08 Mar '18

New submission from Chris PeBenito: Here: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network In the constructor documentation, item 1 says: """ A string consisting of an IP address and an optional mask, separated by a slash (/). The IP address is the network address, and the mask can be either a single number, which means it’s a prefix, or a string representation of an IPv6 address. If it’s the latter, the mask is interpreted as a net mask. If no mask is provided, it’s considered to be /128. For example, the following address specifications are equivalent: 2001:db00::0/24 and 2001:db00::0/ffff:ff00::. """ However in issue22800 it has been identified that using the expanded netmask (e.g. ff00::/ff00::) is not supported. ---------- assignee: docs@python components: Documentation messages: 230871 nosy: docs@python, pebenito priority: normal severity: normal status: open title: IPv6Network constructor docs incorrect about valid input type: behavior versions: Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22822> _______________________________________

4 3

[issue25197] Allow documentation switcher to change url to /3/ and /dev/
by Matthias Bussonnier 06 Mar '18

06 Mar '18

New submission from Matthias Bussonnier: The current documentation version switcher does not allow to get back to the `python.org/3/..` and `python.org/dev/...` url who permanently track the stable/developement release of Python the attached patch allows that and should permit in the long term less link on the internet to be out of date. ---------- assignee: docs@python components: Documentation files: docp.patch keywords: patch messages: 251177 nosy: docs@python, mbussonn priority: normal severity: normal status: open title: Allow documentation switcher to change url to /3/ and /dev/ type: enhancement Added file: http://bugs.python.org/file40529/docp.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25197> _______________________________________

4 3

[issue18855] Inconsistent README filenames
by Madison May 01 Mar '18

01 Mar '18

New submission from Madison May: Is there any reason (other than backwards compatibility) that the names of README files are inconsistent? README: 3 instances - root, /Mac, /Misc, /Tools readme.txt: 2 instances - /PC, /PCbuild README.txt: 1 instance - /Doc ---------- assignee: docs@python components: Documentation messages: 196299 nosy: docs@python, madison.may priority: normal severity: normal status: open title: Inconsistent README filenames _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18855> _______________________________________

11 11

[issue19894] zipfile ignores deflate level settings in zipinfo object
by Richard Milne 26 Feb '18

26 Feb '18

New submission from Richard Milne: Reading the pkzip APPNOTE and the documentation for the zipfile module, I was under the impression that I could set the DEFLATE compression level, on a per-file basis, for each file added to an archive, by setting the appropriate bits in zipinfo.flag_bits. You can't. Hence the attached patch, which updates the docs, tests and module source to enables this ability and makes the user aware of it. ---------- assignee: docs@python components: Documentation, Library (Lib), Tests files: zipfileinfo.diff keywords: patch messages: 205284 nosy: docs@python, rmilne priority: normal severity: normal status: open title: zipfile ignores deflate level settings in zipinfo object type: behavior versions: Python 2.7 Added file: http://bugs.python.org/file32984/zipfileinfo.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19894> _______________________________________

4 4

[issue25059] Mistake in input-output tutorial regarding print() seperator
by Saimadhav Heblikar 25 Feb '18

25 Feb '18

New submission from Saimadhav Heblikar: Feel free to make changes to the patch if you want to improve the sentence structure. ---------- assignee: docs@python components: Documentation messages: 250390 nosy: docs@python, sahutd priority: normal severity: normal status: open title: Mistake in input-output tutorial regarding print() seperator versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25059> _______________________________________

6 14

[issue17232] Improve -O docs
by Maciej Fijalkowski 25 Feb '18

25 Feb '18

New submission from Maciej Fijalkowski: This is what the current documentation says: -O Turn on basic optimizations. This changes the filename extension for compiled (bytecode) files from .pyc to .pyo. See also PYTHONOPTIMIZE. -OO Discard docstrings in addition to the -O optimizations. As far as I know, the only "optimization" that's done is removal of __debug__ sections and assert statements and has been like this for years. Maybe it should say so "-O does not do any optimizations, only removes assert statement" or so. ---------- assignee: docs@python components: Documentation messages: 182365 nosy: docs@python, fijall priority: normal severity: normal status: open title: Improve -O docs type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17232> _______________________________________

15 33

[issue18356] help(numpy) causes segfault on exit
by Michelle Arzul 22 Feb '18

22 Feb '18

New submission from Michelle Arzul: As far as we could tell this bug is only consistently reproducible on Ubuntu 13.04. A line in pydoc.py causes a segfault when help(numpy) (no other libraries that I know of) exits. The offending method is pipepager(). For a full trackdown and workaround of the problem see http://stackoverflow.com/questions/17344974/python-helpnumpy-causes-segfaul… ---------- assignee: docs@python components: Documentation messages: 192276 nosy: Leeward, docs@python priority: normal severity: normal status: open title: help(numpy) causes segfault on exit type: crash versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18356> _______________________________________

6 9