Mailman 3 January 2019 - docs

[issue35603] table header in output of difflib.HtmlDiff.make_table is not escaped and can be rendered as code in the browser
by Karthikeyan Singaravelan Jan. 5, 2019

Jan. 5, 2019

Change by Karthikeyan Singaravelan <tir.karthi(a)gmail.com>: ---------- pull_requests: +10878, 10879 stage: needs patch -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35603> _______________________________________

1 0

[issue35603] table header in output of difflib.HtmlDiff.make_table is not escaped and can be rendered as code in the browser
by Karthikeyan Singaravelan Jan. 5, 2019

Jan. 5, 2019

Change by Karthikeyan Singaravelan <tir.karthi(a)gmail.com>: ---------- pull_requests: +10878 stage: needs patch -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35603> _______________________________________

1 0

[issue35603] table header in output of difflib.HtmlDiff.make_table is not escaped and can be rendered as code in the browser
by Serhiy Storchaka Jan. 5, 2019

Jan. 5, 2019

Serhiy Storchaka <storchaka+cpython(a)gmail.com> added the comment: Yes, please make a documentation PR. Since this behavior can cause a security hole in the user code, make this note visually attractive (maybe use the "note" directive). ---------- stage: patch review -> needs patch _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35603> _______________________________________

1 0

[issue35649] http.client doesn't close. Infinite loop
by Terry J. Reedy Jan. 4, 2019

Jan. 4, 2019

Change by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- versions: +Python 3.8 -Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35649> _______________________________________

1 0

[issue15457] consistent treatment of generator terminology
by Chris Jerdonek Jan. 4, 2019

Jan. 4, 2019

New submission from Chris Jerdonek <chris.jerdonek(a)gmail.com>: The documentation on generators (outside of PEP 255) does not currently educate the reader on the more specific "generator function" and "generator iterator" terminology, or at least not in any consistent or systematic way. For example, the glossary includes only a single entry for "generator," and that entry does not mention the two more specific forms. I think it would help for general discourse purposes if this distinction were made clearer, while still continuing to allow for the use of the generic word "generator" when the context makes it clear. There are also cases where index entries can be improved in this regard, and where references to the section containing details about generators can still be added. I am in the process of completing a proposed patch. ---------- assignee: docs@python components: Documentation keywords: easy messages: 166474 nosy: cjerdonek, docs@python priority: normal severity: normal status: open title: consistent treatment of generator terminology versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15457> _______________________________________

4 12

[issue33896] Document what components make up the filecmp.cmp os.stat signature.
by Cheryl Sabella Jan. 4, 2019

Jan. 4, 2019

Change by Cheryl Sabella <cheryl.sabella(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation -Library (Lib) nosy: +docs@python versions: -Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33896> _______________________________________

1 0

[issue35168] shlex punctuation_chars inconsistency
by Cheryl Sabella Jan. 4, 2019

Jan. 4, 2019

Change by Cheryl Sabella <cheryl.sabella(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation -Library (Lib) keywords: +easy nosy: +docs@python stage: -> needs patch versions: -Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35168> _______________________________________

1 0

[issue35631] Improve typing docs wrt abstract/concrete collection types
by Ville Skyttä Jan. 4, 2019

Jan. 4, 2019

New submission from Ville Skyttä <ville.skytta(a)iki.fi>: The typing docs for List includes a note to use generic collection types, but lists AbstractSet and Mapping which aren't generally replacements for a List. It would be better to remove those types from the List note and add corresponding ones to Dict and Set which are currently lacking it. Additionally, some examples in the typing docs are in violation of the above stated preference, using Lists and Dicts as parameters. ---------- assignee: docs@python components: Documentation messages: 332842 nosy: docs@python, scop priority: normal severity: normal status: open title: Improve typing docs wrt abstract/concrete collection types type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35631> _______________________________________

3 14

[issue35609] Improve of abc.py docstring
by Emmanuel Arias Jan. 4, 2019

Jan. 4, 2019

New submission from Emmanuel Arias <emmanuelarias30(a)gmail.com>: Hi! I prepare a little improve. I added some samples usage, some clarification and delete some whitespace unnecessary. Attach patch. Regards ---------- assignee: docs@python components: Documentation files: 0001-improve-abc.py-docstring.patch keywords: patch messages: 332693 nosy: docs@python, eamanu priority: normal severity: normal status: open title: Improve of abc.py docstring type: enhancement versions: Python 3.8 Added file: https://bugs.python.org/file48021/0001-improve-abc.py-docstring.patch _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35609> _______________________________________

3 14

[issue35655] documentation have wrong info about fibo module examples
by Juan Jan. 4, 2019

Jan. 4, 2019

New submission from Juan <juanbaio10(a)gmail.com>: The below sections in modules documentation have wrong information about fibo module: 6. Modules 6.1. More on Modules 6.1.1. Executing modules as scripts 6.3. The dir() Function The name of module is Fibo not fibo and the attributes are fab,fab2 not fib,fib2. root@archlinux ~]# python2 --version Python 2.7.15 [root@archlinux ~]# pip2 --version pip 18.1 from /usr/lib/python2.7/site-packages/pip (python 2.7) [root@archlinux ~]# pip2 install fibo Collecting fibo Using cached https://files.pythonhosted.org/packages/24/50/e74bd48bbef1040afb01b107e6cfb… Installing collected packages: fibo Running setup.py install for fibo ... done Successfully installed fibo-1.0.0 [root@archlinux ~]# pip2 list modules |grep -i fibo Fibo 1.0.0 [root@archlinux ~]# python2 Python 2.7.15 (default, Jun 27 2018, 13:05:28) [GCC 8.1.1 20180531] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import fibo Traceback (most recent call last): File "<stdin>", line 1, in <module> ImportError: No module named fibo >>> import Fibo >>> Fibo.fib(10) Traceback (most recent call last): File "<stdin>", line 1, in <module> AttributeError: 'module' object has no attribute 'fib' >>> Fibo.fib2(10) Traceback (most recent call last): File "<stdin>", line 1, in <module> AttributeError: 'module' object has no attribute 'fib2' >>> Fibo.fab(10) 1 1 2 3 5 8 13 21 34 55 >>> Fibo.fab2(10) [1, 1, 2, 3, 5, 8, 13, 21, 34, 55] >>> Fibo.__name__ 'Fibo' >>> dir(Fibo) ['Fab', '__builtins__', '__doc__', '__file__', '__name__', '__package__', 'fab', 'fab2', 'fab4'] ---------- assignee: docs@python components: Documentation messages: 332967 nosy: docs@python, eric.araujo, ezio.melotti, juanbaio10, mdk, willingc priority: normal severity: normal status: open title: documentation have wrong info about fibo module examples type: enhancement versions: Python 2.7, Python 3.4, Python 3.5, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35655> _______________________________________

2 1