Mailman 3 January 2016 - docs

[issue26205] Inconsistency concerning nested scopes
by Roscoe R.Higgins Nov. 4, 2020

Nov. 4, 2020

New submission from Roscoe R.Higgins: In chapter 9. Classes of the Python3.5 documentation it says: "At any time during execution, there are at least three nested scopes whose namespaces are directly accessible:", followed by a list containing 4 items. Further down a middle scope is mentioned (although mentioned by name). This was confusing for a while. ---------- assignee: docs@python components: Documentation messages: 258941 nosy: Roscoe R. Higgins, docs@python priority: normal severity:… [View More]

10 26

[issue14379] Several traceback docs improvements
by anatoly techtonik Nov. 4, 2020

Nov. 4, 2020

New submission from anatoly techtonik <techtonik(a)gmail.com>: Some notes about current `traceback` documentation: http://docs.python.org/library/traceback.html 1. It needs a mentioning that traceback module works with traceback objects and frame objects 2. Functions that work with frames should probably be grouped together 3. Docs for frame function should include info about where to get frames (e.g. http://docs.python.org/library/inspect.html#the-interpreter-stack) 4. There is no … [View More]

4 4

[issue9499] Python C/API Execution namespace undocumented. (patch included)
by Campbell Barton Nov. 2, 2020

Nov. 2, 2020

New submission from Campbell Barton <ideasman42(a)gmail.com>: Some parts of the python api expect __main__ module dictionary to be the namespace when executing a script, this is true when running a python script from the python binary but NOT true when running a compiled script from the C/API which can lead to bugs which are not easy to solve unless the C/API author knows this. ---------- assignee: docs@python components: Documentation files: doc_py3_main_mod.diff keywords: patch … [View More]

3 4

[issue14219] start the Class tutorial in a more gentle manner
by Tshepang Lekhonkhobe Nov. 1, 2020

Nov. 1, 2020

New submission from Tshepang Lekhonkhobe <tshepang(a)gmail.com>: Looking at Doc/tutorial/classes, the section "Python Scopes and Namespaces" is full of heavy/deep information. I expect that people who would be able to properly digest that info are people who are already advanced at Python, and therefore maybe it should be moved to some cookbook (or language reference). I would prefer something gentler, since the tutorial is for Python newbies who aren't necessarily conversant with OO … [View More]

4 5

[issue21078] multiprocessing.managers.BaseManager.__init__'s "serializer" argument is not documented
by Yuriy Taraday Oct. 30, 2020

Oct. 30, 2020

New submission from Yuriy Taraday: We're going to use BaseManager for simple secure local RPC and for the "secure" part we can't use pickle, so we have to use "serializer" argument to switch to xmlrpclib. We need to be sure that argument won't go away so we need it to be documented and supported on future versions. ---------- assignee: docs@python components: Documentation messages: 214967 nosy: docs@python, yorik.sar priority: normal severity: normal status: open title: multiprocessing.… [View More]

5 7

[issue10936] Simple CSS fix for left margin at docs.python.org
by Christopher Dunn Oct. 30, 2020

Oct. 30, 2020

New submission from Christopher Dunn <cdunn2001(a)gmail.com>: This is an easy one. When I zoom my browser in (with Ctrl+ or Apple+) the left-side navigation margin gets bigger and bigger, pushing the useful text off the screen. That has bothered me (and anyone else with 40+ year old eyes) ever since the switch to the newest doc format with Sphinx. There is no fix that will satisfy everyone. People with perfect vision might like to zoom out (with Ctrl- or Apple-), since the margin … [View More]

8 16

[issue15029] Update Defining New Types chapter according to PEP 253
by Mateusz Loskot Oct. 27, 2020

Oct. 27, 2020

New submission from Mateusz Loskot <mateusz(a)loskot.net>: The chapter '2. Defining New Types" in the Python 3.2 documentation [1] does not cover all important elements, especially in the subsection 2.1.4. Subclassing other types. The accepted PEP 253 [2] provides much more detailed and thorough explanation for Python C API users willing to define and subclass new types, than the official manual. I'd like to suggest update of the manual with information enclosed in the PEP 253. In fact,… [View More]

2 2

[issue21510] fma documentation should provide better example.
by Jayanth Koushik Oct. 26, 2020

Oct. 26, 2020

New submission from Jayanth Koushik: The documentation for decimal.fma provides an example which fails to illustrate the most important feature of the function i.e. single rounding. In fact: Decimal(2).fma(3, 5) == Decimal(2)*3 + 5 An example such as this would make it much more clear: >>> getcontext().prec = 2 >>> getcontext().rounding = ROUND_DOWN >>> Decimal('1.5')*Decimal('1.5') + Decimal('1.05') Decimal('3.2') >>> Decimal('1.5'… [View More]

6 7

[issue15339] document the threading "facts of life" in Python
by Chris Jerdonek Oct. 26, 2020

Oct. 26, 2020

New submission from Chris Jerdonek <chris.jerdonek(a)gmail.com>: I think it would be helpful if the Python documentation included certain high-level information about multi-threading in Python. At minimum, I think it would help for the documentation to provide a definition that can be linked to of what it means when some part of the Python documentation says something is "thread-safe". In particular, such a definition could clarify that this is different from being atomic. This might … [View More]

8 8

[issue12832] The documentation for the print function should explain/point to how to control the sys.stdout encoding
by R. David Murray Oct. 25, 2020

Oct. 25, 2020

New submission from R. David Murray <rdmurray(a)bitdance.com>: A common problem encountered when using python3 is writing non-ascii to stdout. This will work fine if stdout is a terminal and the terminal encoding handles the characters, but will fail if stdout is later redirected to a pipe. The docs for sys.stdout and for print should contain or point to an explanation of why, and how to solve the problem (ie: how to set the encoding for sys.stdout/sys.stderr). Note that IMO it makes … [View More]

4 7