docs February 2020

docs@python.org

14 participants
390 discussions

by hai shi

New submission from hai shi <shihai1991(a)126.com>: 1. examples don't need import argparse much times(IMHO, it should be a default behavior); 2. argparse have no doctest, it's not a good behavior; ---------- assignee: docs@python components: Documentation messages: 361213 nosy: docs@python, mdk, rhettinger, shihai1991 priority: normal severity: normal status: open title: Update doc of argparse.rst type: enhancement versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39527> _______________________________________

1 year, 7 months

[issue39480] referendum reference is needlessly annoying

by Ian Jackson

New submission from Ian Jackson <dlgruj(a)fyvzl.net>: The section "Fancier Output Formatting" has the example below. This will remind many UK readers of the 2016 EU referendum. About half of those readers will be quite annoyed. This annoyance seems entirely avoidable; a different example which did not refer to politics would demonstrate the behaviour just as well. Changing this example would (in the words of the CoC) also show more empathy, and be more considerate towards, python contributors unhappy with recent political developments in the UK, without having to make anyone else upset in turn. >>> year = 2016 >>> event = 'Referendum' >>> f'Results of the {year} {event}' 'Results of the 2016 Referendum' >>> yes_votes = 42_572_654 >>> no_votes = 43_132_495 >>> percentage = yes_votes / (yes_votes + no_votes) >>> '{:-9} YES votes {:2.2%}'.format(yes_votes, percentage)' 42572654 YES votes 49.67%' ---------- assignee: docs@python components: Documentation messages: 360883 nosy: diziet, docs@python priority: normal severity: normal status: open title: referendum reference is needlessly annoying versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39480> _______________________________________

1 year, 7 months

[issue38558] Data Structures documentation out of sync with new Walrus operator

by Matt Ward

New submission from Matt Ward <matt(a)matthewward.net>: The 3.8 documentation still includes the text. ```Note that in Python, unlike C, assignment cannot occur inside expressions. C programmers may grumble about this, but it avoids a common class of problems encountered in C programs: typing = in an expression when == was intended.``` https://docs.python.org/3.8/tutorial/datastructures.html#more-on-conditions This would seem to no longer be the case with with the inclusion of https://www.python.org/dev/peps/pep-0572/ in 3.8 unless I am misunderstanding the above statement. ---------- assignee: docs@python components: Documentation messages: 355151 nosy: Matt Ward, docs@python priority: normal severity: normal status: open title: Data Structures documentation out of sync with new Walrus operator type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue38558> _______________________________________

1 year, 7 months

Possible bug in documentation of Return value in Try/Except/Finally block

by Tapan Parmar

Hello guys, I have come across this question https://stackoverflow.com/questions/59639733/python-docs-have-misleading-ex… Please check this out, I think the Doc is misleading on this specific topic. Best Regards, Tapan H. Parmar Data scientist | Technical Team lead - Python INEXTURE Solutions LLP LinkedIn <https://www.linkedin.com/in/tapanhp/> | +91 95744 31893

1 year, 7 months

[issue39535] multiprocessing.Process file descriptor resource leak

by Robert Pierce

New submission from Robert Pierce <robert.pierce(a)decisionnext.com>: multiprocessing.Process opens a FIFO to the child. This FIFO is not documented the the Process class API and it's purpose is not clear from the documentation. It is a minor documentation bug that the class creates non-transparent resource utilization. The primary behavioral bug is that incorrect handling of this FIFO creates a resource leak, since the file descriptor is not closed on join(), or even when the parent Process object goes out of scope. The effect of this bug is that programs generating large numbers of Process objects will hit system resource limits of open file descriptors. ---------- assignee: docs@python components: Documentation, Library (Lib) files: proc_test.py messages: 361273 nosy: Robert Pierce, docs@python priority: normal severity: normal status: open title: multiprocessing.Process file descriptor resource leak type: resource usage versions: Python 3.6 Added file: https://bugs.python.org/file48878/proc_test.py _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39535> _______________________________________

1 year, 7 months

[issue12731] python lib re uses obsolete sense of \w in full violation of UTS#18 RL1.2a

by STINNER Victor

Change by STINNER Victor <vstinner(a)python.org>: ---------- nosy: -vstinner _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue12731> _______________________________________

1 year, 7 months

Thank you

by Douglas J. Sheehan

I was just reading the 3.8.1 documentation page on section 9.Classes, and found it very well written and easy to read. Maybe my understanding of the material is improving, but I think it is more the case of being clearly written and well organized. Thank you for your efforts. It helps me out a lot. -- Douglas J. Sheehan doug(a)txdrxd.com

1 year, 7 months

[issue39391] Nondeterministic Pydoc output on functions that have functions as default parameters

by Peter Occil

New submission from Peter Occil <poccil14(a)gmail.com>: It appears that if a method has default parameters set to functions, as in this example: def f1(): pass def f2(a, b=f1): pass The resulting Pydoc output produces a different, nondeterministic rendering for the f2 method each time it generates the documentation, such as `m1(a, b=<function f1 at 0x7f4ff67f8950>)` or `m1(a, b=<function f1 at 0x7f4ff67f8950>)`. And this is problematic for version control systems, among other things, especially since this is not a meaningful change to the documentation. One solution may be to write, say, `m1(a, b=f1)` instead. ---------- assignee: docs@python components: Documentation messages: 360278 nosy: Peter Occil, docs@python priority: normal severity: normal status: open title: Nondeterministic Pydoc output on functions that have functions as default parameters type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39391> _______________________________________

1 year, 7 months

[issue39518] Dark theme

by Vitaly Zdanevich

New submission from Vitaly Zdanevich <vitaly.zdanevich(a)gmail.com>: Please save our eyes. And batteries. Do not ignore this property of useragent https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme ---------- assignee: docs@python components: Documentation messages: 361177 nosy: Vitaly Zdanevich, docs@python priority: normal severity: normal status: open title: Dark theme _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39518> _______________________________________

1 year, 7 months

[issue29249] Pathlib glob ** bug

by Isaac Muse

Isaac Muse <faceless.server1(a)gmail.com> added the comment: I think the idea of adding a globmatch function is a decent idea. That is what I did in a library I wrote to get more out of glob than what Python offered out of the box: https://facelessuser.github.io/wcmatch/pathlib/#purepathglobmatch. Specifically the differences are globmatch is just a pure match of a path, it doesn't do the implied `**` at the beginning of a pattern like match does. While it doesn't enable `**` by default, such features are controlled by flags >>> pathlib.Path("a/b/c/d/e.txt").match('a/*/**/*', flags=pathlib.GLOBSTAR) True This isn't to promote my library, but more to say, as a user, I found such functionality worth adding. I think it would be generally nice to have such functionality in some form in Python by default. Maybe something called `globmatch` that offers that could be worthwhile. ---------- nosy: +Isaac Muse _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue29249> _______________________________________

1 year, 7 months

Jump to page:

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

docs February 2020