Mailman 3 March 2017 - docs

[issue29026] time.time() documentation should mention UTC timezone
by STINNER Victor March 24, 2017

March 24, 2017

New submission from STINNER Victor: The documentation of the time.time() mentions "epoch" which it doesn't define epoch. If I recall correctly, it's January 1st, 1970 on most OS and most implementations of Python, except of IronPython which uses a different epoch. https://docs.python.org/dev/library/time.html#time.time Moreover, the timezone is not defined. In practice, it's UTC, so it would be nice to document it. I opened this issue because I wasn't sure if time.time() is impacted by DST or not. The answer is no. Maybe the behaviour of time.time() on DST should also be documentation. Hint: it is not impacted by DST since it uses UTC timezone. Related question on StackOverflow: http://stackoverflow.com/questions/32469318/python-time-time-and-daylight-s… ---------- assignee: docs@python components: Documentation messages: 283690 nosy: belopolsky, docs@python, haypo priority: normal severity: normal status: open title: time.time() documentation should mention UTC timezone versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29026> _______________________________________

6 17

[issue29455] Mention coverage.py in trace module documentation
by Brett Cannon March 24, 2017

March 24, 2017

New submission from Brett Cannon: In the trace module it would be nice to also mention that coverage.py is available. ---------- assignee: docs@python components: Documentation messages: 287075 nosy: brett.cannon, docs@python priority: normal severity: normal status: open title: Mention coverage.py in trace module documentation type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29455> _______________________________________

3 9

[issue29709] Short-circuiting not only on False and True
by Stefan Pochmann March 24, 2017

March 24, 2017

New submission from Stefan Pochmann: The notes at https://docs.python.org/3/library/stdtypes.html#boolean-operations-and-or-n… say that `or` "only evaluates the second argument if the first one is False" and that `and` "only evaluates the second argument if the first one is True". Should say "false" and "true" instead of "False" and "True". ---------- assignee: docs@python components: Documentation messages: 288881 nosy: Stefan Pochmann, docs@python priority: normal severity: normal status: open title: Short-circuiting not only on False and True type: enhancement versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29709> _______________________________________

4 12

[issue26213] Document BUILD_LIST_UNPACK & BUILD_TUPLE_UNPACK
by Brett Cannon March 24, 2017

March 24, 2017

New submission from Brett Cannon: Turns out the BUILD_TUPLE_UNPACK and BUILD_LIST_UNPACK opcodes are undocumented in the dis module. ---------- assignee: docs@python components: Documentation messages: 258985 nosy: benjamin.peterson, brett.cannon, docs@python priority: low severity: normal stage: needs patch status: open title: Document BUILD_LIST_UNPACK & BUILD_TUPLE_UNPACK versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26213> _______________________________________

4 13

[issue29896] ElementTree.fromstring raises undocumented UnicodeError
by Terry J. Reedy March 24, 2017

March 24, 2017

Terry J. Reedy added the comment: I disagree. The docs only sporadically mention specific exceptions for specific functions. UnicodeDecodeError can occur any place bytes are decoded to unicode. I think this should be closed. Builtin exceptions are documented in https://docs.python.org/3/library/exceptions.html. Module docs document additional exceptions defined in a module. ParseError is one such. https://docs.python.org/3/library/xml.etree.elementtree.html#exceptions. It is not specifically mentioned in the entry for fromstring or .feed. I also disagree that the decode error should be wrapped as a parse error. It happens before parsing in the data preparation step, and the UnicodeDecodeError message give 3 pieces of information specific to the problem. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, terry.reedy status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29896> _______________________________________

1 0

[issue28331] "CPython implementation detail:" is removed when contents is translated
by INADA Naoki March 24, 2017

March 24, 2017

New submission from INADA Naoki: "CPython implementation detail:" label is removed when contents of impl-detail directive is translated. This is very bad for people reading translated documents. Attached patch fixes this, with enabling translating the label, like versionchanged directive. ---------- assignee: docs@python components: Documentation files: impl-detail.patch keywords: patch messages: 277817 nosy: docs@python, inada.naoki priority: normal severity: normal stage: patch review status: open title: "CPython implementation detail:" is removed when contents is translated type: enhancement versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7 Added file: http://bugs.python.org/file44910/impl-detail.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28331> _______________________________________

4 13

[issue29772] Unintentionally deleted line on library/collections.rst
by Kinebuchi Tomohiko March 24, 2017

March 24, 2017

New submission from Kinebuchi Tomohiko: The last part of "Counter objects" section has a strange line: "in Smalltalk." https://docs.python.org/2.7/library/collections.html#counter-objects The line just before "in Smalltalk" might be deleted by accident. Related issue is bpo-25910 [1]_ and the applied patch is this [2]_, although an intended patch might looks like this [3]_. .. [1] http://bugs.python.org/issue25910 .. [2] https://hg.python.org/cpython/rev/14e00e7e4d51#l15.7 patch for the 2.7 branch .. [3] https://hg.python.org/cpython/rev/ce5ef48b5140#l21.7 patch for the 3.5 branch I will create a pull request. ---------- assignee: docs@python components: Documentation messages: 289300 nosy: cocoatomo, docs@python priority: normal severity: normal status: open title: Unintentionally deleted line on library/collections.rst versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29772> _______________________________________

4 4

[issue28739] PEP 498: docstrings as f-strings
by Mariatta Wijaya March 24, 2017

March 24, 2017

Mariatta Wijaya added the comment: New changeset d4e89287b397c7382c12d3f3d9fd901fd8243b3c by Mariatta in branch 'master': bpo-28739: Document that f-strings cannot be used as docstring (GH-592) https://github.com/python/cpython/commit/d4e89287b397c7382c12d3f3d9fd901fd8… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28739> _______________________________________

1 0

[issue28739] PEP 498: docstrings as f-strings
by Mariatta Wijaya March 24, 2017

March 24, 2017

Mariatta Wijaya added the comment: New changeset ff6f3716279e75b2519133a82b9de0c3601963d9 by Mariatta in branch '3.6': bpo-28739: Document that f-strings cannot be used as docstring (GH-592) (GH-600) https://github.com/python/cpython/commit/ff6f3716279e75b2519133a82b9de0c360… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28739> _______________________________________

1 0

[issue29784] Erroneous link in shutil.copy description
by Maxime Buquet March 24, 2017

March 24, 2017

New submission from Maxime Buquet: https://docs.python.org/3/library/shutil.html#shutil.copy The link to "copy()" in the description seems to be pointing to the copy module, but I suppose it was meant to point at shutil.copy. ---------- assignee: docs@python components: Documentation messages: 289370 nosy: docs@python, pep. priority: normal severity: normal status: open title: Erroneous link in shutil.copy description _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29784> _______________________________________

4 11