Mailman 3 December 2017 - docs

[issue28612] str.translate needs a mapping example
by Jim Jewett March 13, 2018

March 13, 2018

New submission from Jim Jewett: One commonly needed string transformation is stripping out certain characters (or only keeping certain characters). This is common enough that it might be worth a dedicated method, except, that, as Stephen J. Turnbull wrote in https://mail.python.org/pipermail/python-ideas/2016-November/043501.html """ So really translate with defaultdict is a specialized loop that marries an algorithmic body (which could do things like look up the original script or other character properties to decide on the replacement for the generic case) with a (usually "small") table of exceptions. That seems like inspired design to me. """ Alas, while inspired, it isn't obvious to someone who isn't yet used to the power of python custom classes. The documentation (such as https://docs.python.org/3/library/stdtypes.html?highlight=translate#str.tra… ) should include such an example. One possible example would be a defaultdict that says to discard any characters except lower case ASCII lettersI. ---------- assignee: docs@python components: Documentation keywords: easy messages: 280061 nosy: Jim.Jewett, docs@python priority: normal severity: normal stage: needs patch status: open title: str.translate needs a mapping example type: enhancement versions: Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28612> _______________________________________

7 9

[issue25910] Fixing links in documentation
by SilentGhost March 10, 2018

March 10, 2018

New submission from SilentGhost: I've run 'make linkcheck' on Doc and it highlighted a number of faulty links in documentation. I've tried fixing some of them and here is the resulting patch. It's a bit too long and touches many files, so to summarise: * Most changes are http->https redirect (many from wikipedia and microsoft, but some from independent project) * New domains, sometimes without redirect or any indication of how to find the same information. * Completely new locations, only discoverable via search engine. * Few dead links, that I removed. I'm going to attach output.txt that is produced after running linkcheck with this patch applied, it is about three time smaller than the original one and has this types of issues: * Dead links in licenses * Internal redirects to versioned text * Many python.org links in whatsnew/ that I don't know what to do about * Spurious bad links ---------- assignee: docs@python components: Documentation files: linkcheck.diff keywords: needs review, patch messages: 256728 nosy: SilentGhost, docs@python, r.david.murray, zach.ware priority: normal severity: normal stage: needs patch status: open title: Fixing links in documentation versions: Python 3.5, Python 3.6 Added file: http://bugs.python.org/file41361/linkcheck.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25910> _______________________________________

18 62

[issue22822] IPv6Network constructor docs incorrect about valid input
by Chris PeBenito March 8, 2018

March 8, 2018

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 March 6, 2018

March 6, 2018

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 March 1, 2018

March 1, 2018

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

[issue30607] Extract documentation theme into a separate package
by Jon Wayne Parrott March 1, 2018

March 1, 2018

New submission from Jon Wayne Parrott: As part of an effort to align the packaging documentation (packaging.python.org) with the CPython docs, PyPA has extracted the theme used in the CPython documentation into a separate repository and package (https://github.com/python/python-docs-theme). This bug is to track removing the now duplicate theme code from CPython and relying on the externalized version. Context links: 1. https://mail.python.org/pipermail/python-dev/2017-May/148029.html 2. https://github.com/pypa/python-packaging-user-guide/pull/305 ---------- assignee: docs@python components: Documentation messages: 295482 nosy: Jon Wayne Parrott, brett.cannon, docs@python, dstufft, ncoghlan priority: normal severity: normal status: open title: Extract documentation theme into a separate package type: enhancement versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30607> _______________________________________

3 4

[issue26792] docstrings of runpy.run_{module, path} are rather sparse
by Antony Lee Feb. 27, 2018

Feb. 27, 2018

New submission from Antony Lee: $ pydoc runpy run_module(mod_name, init_globals=None, run_name=None, alter_sys=False) Execute a module's code without importing it Returns the resulting top level namespace dictionary run_path(path_name, init_globals=None, run_name=None) Execute code located at the specified filesystem location Returns the resulting top level namespace dictionary The file path may refer directly to a Python script (i.e. one that could be directly executed with execfile) or else it may refer to a zipfile or directory containing a top level __main__.py script. The meaning of the arguments should be documented (e.g. by copy-pasting the html docs). (And some sentences are missing final dots.) ---------- assignee: docs@python components: Documentation messages: 263638 nosy: Antony.Lee, docs@python priority: normal severity: normal status: open title: docstrings of runpy.run_{module,path} are rather sparse versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26792> _______________________________________

3 3

[issue19894] zipfile ignores deflate level settings in zipinfo object
by Richard Milne Feb. 25, 2018

Feb. 25, 2018

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 Feb. 25, 2018

Feb. 25, 2018

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

[issue31454] Include "import as" in documentation
by Steve Johnson Feb. 25, 2018

Feb. 25, 2018

New submission from Steve Johnson: I was wondering if you could do something like fiblib = import fibo or import fibo as fiblib, and low and behold, the "as" variant worked. I find this very useful, and thought it should be part of your documentation on "import" ---------- assignee: docs@python components: Documentation messages: 302083 nosy: docs@python, svenyonson priority: normal severity: normal status: open title: Include "import as" in documentation type: enhancement versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue31454> _______________________________________

9 25