Mailman 3 March 2017 - docs

[issue20001] pathlib inheritance diagram too large
by Antoine Pitrou Feb. 5, 2019

Feb. 5, 2019

New submission from Antoine Pitrou: The inheritance diagram at http://docs.python.org/dev/library/pathlib.html is too large, it can easily take up half the vertical space (or perhaps all of it on a smaller screen). The font size looks fine, it's just that there's a lot of spacing around. (of course, the style could perhaps also be changed or improved) ---------- assignee: docs@python components: Documentation messages: 206354 nosy: docs@python, eli.bendersky, georg.brandl, pitrou priority: low severity: normal status: open title: pathlib inheritance diagram too large versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20001> _______________________________________

7 11

[issue25592] distutils docs: data_files always uses sys.prefix
by Jeroen Demeyer Feb. 2, 2019

Feb. 2, 2019

New submission from Jeroen Demeyer: The documentation for distutils claims that sys.exec_prefix is used in certain cases to install data_files, but this is simply not true (maybe it was true in the past or this sentence was copy/pasted from somewhere else?) ---------- assignee: docs@python components: Documentation files: data_files_doc.patch keywords: patch messages: 254432 nosy: docs@python, jdemeyer priority: normal severity: normal status: open title: distutils docs: data_files always uses sys.prefix versions: Python 2.7 Added file: http://bugs.python.org/file40993/data_files_doc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25592> _______________________________________

5 32

[issue17972] inspect module leak docs
by xiaobing jiang Feb. 1, 2019

Feb. 1, 2019

New submission from xiaobing jiang: the inspect module leak docs. all these functions have no doc. getlineno getabsfile getblock formatannotation walktree findsource indentsize getargs formatannotationrelativeto classify_class_attrs ---------- assignee: docs@python components: Documentation messages: 189193 nosy: docs@python, s7v7nislands(a)gmail.com priority: normal severity: normal status: open title: inspect module leak docs type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17972> _______________________________________

12 19

[issue23156] Update tix install information in tkinter tix chapter of doc
by Terry J. Reedy Jan. 18, 2019

Jan. 18, 2019

New submission from Terry J. Reedy: Update tix install info in doc. "Using tix" starts with 3 lines for testing one's tix install and continues '''If this fails, you have a Tk installation problem which must be resolved before proceeding. Use the environment variable TIX_LIBRARY to point to the installed Tix library directory, and make sure you have the dynamic object library (tix8183.dll or libtix8183.so) in the same directory that contains your Tk dynamic object library (tk8183.dll or libtk8183.so). The directory with the dynamic object library should also have a file called pkgIndex.tcl (case sensitive), which contains the line: package ifneeded Tix 8.1 [list load "[file join $dir tix8183.dll]" Tix]''' Almost nothing above matches my working-with-tix 3.4.2 Win 7 install. I do have a tix library directory: python34/tcl/tix8.4.3, but the version number is much newer. Since it is in the right place, TIX_LIBRARY is not needed and there is none. python34/DLLs contains tcl86t.dll and tk86t.dll and NO tix####.dll. Is the once separate tix dll now part of tk dll? I cannot find pkgIndex.tcl; it is certainly not in the DLLs directory nor in the /tcl. The current doc seems useless to people who do not have tix working. See, for example, https://stackoverflow.com/questions/27751923/tix-widgets-installation-issue which is a semi-repeat question and which claims seeing similar reports elsewhere on the net. ---------- assignee: docs@python components: Documentation, Tkinter messages: 233368 nosy: docs@python, serhiy.storchaka, terry.reedy, zach.ware priority: normal severity: normal stage: needs patch status: open title: Update tix install information in tkinter tix chapter of doc type: behavior versions: Python 2.7, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23156> _______________________________________

5 13

[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

[issue29886] links between binascii.{un, }hexlify / bytes.{, to}hex
by chrysn Dec. 26, 2018

Dec. 26, 2018

New submission from chrysn: The function binascii.{un,}hexlify and bytes.{,to}hex do almost the same things (plus/minus details of whether they accept whitespace, and whether the hex-encoded data is accepted/returned as strings or bytes). I think that it would help users to point that out in the documentation, eg. by adding a "Similar functionality is provided by the ... function." lines at the ends of the functions' documentations. ---------- assignee: docs@python components: Documentation messages: 290050 nosy: chrysn, docs@python priority: normal severity: normal status: open title: links between binascii.{un,}hexlify / bytes.{,to}hex type: enhancement versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29886> _______________________________________

4 8

[issue18085] Verifying refcounts.dat
by Serhiy Storchaka Dec. 20, 2018

Dec. 20, 2018

New submission from Serhiy Storchaka: I found one error in Doc/data/refcounts.dat (see issue9369, second argument of PyObject_CallMethodObjArgs is `PyObject*`, not `char*`). Perhaps there are other errors. How this file was generated first? Is it possible to write a tool which will automatically verify at least signatures of functions? ---------- assignee: docs@python components: Documentation messages: 190236 nosy: docs@python, serhiy.storchaka, skip.montanaro priority: normal severity: normal status: open title: Verifying refcounts.dat type: behavior versions: Python 2.7, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18085> _______________________________________

8 24

[issue9842] Document ... used in recursive repr of containers
by Éric Araujo Nov. 20, 2018

Nov. 20, 2018

New submission from Éric Araujo <merwok(a)netwok.org>: Built-in containers like dict use an ellipsis to represent a recursive item. In the symbols index, “...” only links to the secondary prompt; I think it should also link to a paragraph explaining the display of recursive containers. ---------- assignee: docs@python components: Documentation keywords: easy messages: 116256 nosy: docs@python, eric.araujo priority: normal severity: normal stage: needs patch status: open title: Document ... used in recursive repr of containers versions: Python 2.7, Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9842> _______________________________________

8 17

[issue25438] document what codec PyMemberDef T_STRING decodes the char * as
by Gregory P. Smith Nov. 17, 2018

Nov. 17, 2018

New submission from Gregory P. Smith: https://docs.python.org/3/c-api/structures.html#c.PyMemberDef T_STRING members are turned into str objects in Python. The documentation needs updating to mention which codec the char * bytes are treated as. Solving this issue involves code inspection and leaving pointers to that code here in the issue, then updating the docs to mention the requirements for the char * member data as well as what happens upon assignment for non-READONLY T_STRING data (a different restriction? or encoding to the same codec?) My _guess_ would be UTF-8 or ASCII but I'll let someone else dive in and find out. This is a Python 3 specific documentation clarification. ---------- assignee: docs@python components: Documentation keywords: easy messages: 253172 nosy: docs@python, gregory.p.smith priority: normal severity: normal stage: needs patch status: open title: document what codec PyMemberDef T_STRING decodes the char * as type: behavior versions: Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25438> _______________________________________

5 13

[issue27741] datetime.datetime.strptime functionality description incorrect
by Nicholas Colclasure Oct. 29, 2018

Oct. 29, 2018

New submission from Nicholas Colclasure: The datetime.datetime.strptime documentation states that it is equivalent to datetime(*(time.strptime(date_string, format)[0:6])), but the time.struct_time returned by time.strptime does not include microseconds, implying that datetime's strptime would also not include microseconds, but testing of the functions shows that it does include them. Removing the false statement of equivalence would be enough to remove this bug from the documentation. ---------- assignee: docs@python components: Documentation messages: 272474 nosy: Valectar, docs@python priority: normal severity: normal status: open title: datetime.datetime.strptime functionality description incorrect type: behavior versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27741> _______________________________________

9 19