Mailman 3 September 2018 - docs

[issue25296] Simple End-of-life guide covering all unsupported versions
by Nick Coghlan 15 Sep '18

15 Sep '18

New submission from Nick Coghlan: Katie McLaughlin recently pointed me at PHP's summary page for the End-of-Life dates for their various releases: http://php.net/eol.php That seems like a useful thing to offer, but we unfortunately don't currently have a great place for this kind of documentation: - the main docs are version specific, while this kind of page should be version independent - the update process, access control model and reader experience for python.org is too different from that for the main documentation - ditto for the wiki - informational PEPs are closer from an access control perspective, but aren't generated with Sphinx and are still disconnected from the main docs from a reader perspective - it's off-topic for the developer guide The "right" answer seems to be setting up a separate "docs" project on hg.python.org to use as the landing page for docs.python.org and for version independent information like this (the redirects already defined as part of PEP 430 should continue to handle unqualified deep links into the Python 2 docs). I'm not sure how much reconfiguration work such a change would entail, though. ---------- assignee: docs@python components: Documentation messages: 252084 nosy: docs@python, ncoghlan priority: normal severity: normal status: open title: Simple End-of-life guide covering all unsupported versions type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25296> _______________________________________

12 18

[issue29341] Missing accepting path-like object in docstrings of os module functions
by Karthikeyan Singaravelan 15 Sep '18

15 Sep '18

Change by Karthikeyan Singaravelan <tir.karthi(a)gmail.com>: ---------- nosy: +xtreak _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue29341> _______________________________________

1 0

[issue28955] Not matched behavior of numeric comparison with the documentation
by woo yoo 14 Sep '18

14 Sep '18

New submission from woo yoo: According to the documentation, which said "Additionally, comparing any number to a not-a-number value will return False. ",the comparison of `float('nan')!= 1`should yield False, while the result is True. Small errors like this in documentation should be corrected? The related link https://docs.python.org/3/reference/expressions.html#value-comparisons ---------- assignee: docs@python components: Documentation messages: 283069 nosy: docs@python, woo yoo priority: normal severity: normal status: open title: Not matched behavior of numeric comparison with the documentation type: behavior versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28955> _______________________________________

7 8

[issue34671] Remove references to Benevolent Dictator
by Sebastian Bassi 14 Sep '18

14 Sep '18

New submission from Sebastian Bassi <sbassi(a)users.sourceforge.net>: Following the trend initiated at https://bugs.python.org/issue34605, I want to point out that the term dictator has a negative connotation in Argentina and other countries where we suffered bloody dictatorship (30000 dead and missing persons, or "desaparecidos" as we call it). I understand that the former title BDFL may be funny for most developers, but the term "benevolent dictatorship" (or it Spanish equivalent "dictablanda") was used in Chile by the Pinochet's regime. This title doesn't reflect the democratic nature of the whole project. My suggestion is to take this into account when defining PEP-8010 and related documentation. ---------- assignee: docs@python components: Documentation messages: 325315 nosy: docs@python, sbassi priority: normal severity: normal status: open title: Remove references to Benevolent Dictator type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue34671> _______________________________________

2 1

[issue34675] Avoid terminology related to slavery
by Freed_Slave 14 Sep '18

14 Sep '18

New submission from Freed_Slave <Freed_Slave(a)notmailinator.com>: It is very good to see that "master" and "slave" terminology was removed from the project, however there are still references to "owned" references, as if these references were property. There are also things needing to be "freed" as if they were indentured servants. I would like to open up discussion about better terminology - and when better terminology has been agreed upon I do not mind submitting a PR to get rid of this exclusive language. "Freed" terminology: * https://github.com/python/cpython/search?q=freed&unscoped_q=freed There are also additional instances were "free" is used instead of "clear" but the context makes it harder to discover with a naive search. "Owned" terminology: * https://github.com/python/cpython/search?utf8=%E2%9C%93&q=owned&type= "Master/Slave" terminology, now removed: * https://bugs.python.org/issue34605 On the topic of inclusive/exclusive terminology, there are other problematic things that should be addressed - either here or in separate issues. However I'd like to draw attention to one particularly sexist email in `test_smtplib.py` "my_mom(a)great.cooker.com" - hilarious! Not. It especially sticks out among the more generic and inclusive test emails. I particularly like the inclusion of "Páolo <főo(a)bar.com>" but then in a test email he makes a sexual innuendo. * https://github.com/python/cpython/search?utf8=%E2%9C%93&q=mom&type= * Said innuendo: "oh là là, know what I mean, know what I mean?\n\n")" ---------- assignee: docs@python components: Documentation messages: 325331 nosy: Freed_Slave, docs@python priority: normal severity: normal status: open title: Avoid terminology related to slavery type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue34675> _______________________________________

2 1

[issue33774] Improve doc of @lru_cache to avoid misuse and confusion
by Al-Scandar Solstag 14 Sep '18

14 Sep '18

New submission from Al-Scandar Solstag <solstag(a)member.fsf.org>: Ni! It is not clear at all in the documentation of @lru_cache that the cache takes into account the exact way the function was called, not the values passed to its arguments, as one could/would expect. I mean that for function(a, b, c=3) the three calls below are not considered equivalent as far as the cache is concerned: function(1, 2, 3) function(1, 2, c=3) function(1, 2) I hope this can be clarified in the documentation. I wasted a great deal of time today trying to understand why my calls were not getting cached and only figured it out when I decided to go read @lru_cache's code. It seems very likely that other people have had the same problem. Or worse, people might be using @lru_cache believing it is working when it isn't. Cheers! ---------- assignee: docs@python components: Documentation messages: 318770 nosy: docs@python, solstag priority: normal severity: normal status: open title: Improve doc of @lru_cache to avoid misuse and confusion _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33774> _______________________________________

5 9

[issue34665] Py_FinalizeEx() - Bugs & caveats - Add info that NumPy and Pandas don't support reinitialization
by Johannes M. 13 Sep '18

13 Sep '18

New submission from Johannes M. <jcmueller(a)posteo.de>: Since about a decade, it's a know problem that NumPy and Pandas initialization function crashes on reinitialization after a call to Py_Finalize() + Py_Initialize(). [https://github.com/numpy/numpy/issues/8097] [https://github.com/numpy/numpy/issues/11925] It seems to be unlikely that this problem gets fixed soon. Due to the popularity of the modules, it would be good to add this information to the documentation of Py_FinalizeEx(), such that developers, who are planning to embed Python get this information already at the moment when they read the documentation. I would suggest to change the following sentence: Some extensions may not work properly if their initialization routine is called more than once; to Some extensions, like NumPy and Pandas, may not work properly if their initialization routine is called more than once; ---------- assignee: docs@python components: Documentation messages: 325275 nosy: docs@python, jcmuel priority: normal severity: normal status: open title: Py_FinalizeEx() - Bugs & caveats - Add info that NumPy and Pandas don't support reinitialization type: enhancement versions: Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue34665> _______________________________________

1 0

[issue29341] Missing accepting path-like object in docstrings of os module functions
by Farhaan Bukhsh 13 Sep '18

13 Sep '18

Farhaan Bukhsh <farhaan.bukhsh(a)gmail.com> added the comment: Hey I would like to make this change which file should I look into? ---------- nosy: +fhackdroid _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue29341> _______________________________________

1 0

[issue33986] Typo: BaseSubprocessTransport -> SubprocessTransport
by Bumsik Kim 12 Sep '18

12 Sep '18

New submission from Bumsik Kim <kbumsik(a)gmail.com>: https://docs.python.org/3/library/asyncio-protocol.html#basesubprocesstrans… I belive the doc has a wrong name "basesubprocesstransport" and it should be "Subprocesstransport". You can see this in the source code: https://github.com/python/cpython/blob/3.6/Lib/asyncio/transports.py ---------- assignee: docs@python components: Documentation messages: 320638 nosy: docs@python, kbumsik priority: normal severity: normal status: open title: Typo: BaseSubprocessTransport -> SubprocessTransport versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33986> _______________________________________

3 6

Another bug in Python 3.7 docs.
by Никита Люшненко 12 Sep '18

12 Sep '18

https://docs.python.org/3/reference/expressions.html#yield-expressions Term "sub-generator" is used in PEP 280 without dash ("-") symbol - "subgenerator". At the same time it is used as "sub-generator" 2 times on this page: "generator (by returning a value from the sub-generator)." - here. "The proposal to introduce the yield_from syntax, making delegation to sub-generators easy." - and here. -- Sincerely, ZooDSS ZooDSS(a)yandex.ru

1 0