docs

docs@python.org

14 participants
15142 discussions

[issue42198] Clean up docs for Union and GenericAlias

by Ken Jin

New submission from Ken Jin <kenjin4096(a)gmail.com>: This is an umbrella issue to clean up docs for Union and GenericAlias. To-do (not in order): 1. Update links in typing, subscription and union to point to GenericAlias. 2. Park GenericAlias and Union under a new section 'Type Annotation Types' in stdtypes for 3.10. The reason is to follow with the rest of the stdtypes' doc convention. 3. Consistency nitpicks for Union's docs. ---------- assignee: docs@python components: Documentation messages: 379876 nosy: docs@python, gvanrossum, kj priority: normal severity: normal status: open title: Clean up docs for Union and GenericAlias versions: Python 3.10, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42198> _______________________________________

1 hour, 59 minutes

[issue42201] Priority queue realization issue

by Даниил Ляхов

New submission from Даниил Ляхов <dupeljan(a)gmail.com>: In Priority queue realization in docs https://docs.python.org/3/library/heapq.html there is no appointments that priority can be equal and the task can have different type. For example, if you store number of graph node in your priority queue, than it is possible to get "TypeError: '<' not supported between instances of 'int' and 'str'", because inside heappop there is comparison between elements, and if the fist elements the same, than it compare tasks, which can be tagged as removed and has '<removed-task>' value as opposed to number of node, which is int. ---------- assignee: docs@python components: Documentation messages: 379922 nosy: docs@python, dupeljan priority: normal severity: normal status: open title: Priority queue realization issue type: behavior versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42201> _______________________________________

3 hours, 38 minutes

[issue14845] list(<generator expression>) != [<list comprehension>]

by Irit Katriel

Change by Irit Katriel <iritkatriel(a)yahoo.com>: ---------- resolution: -> out of date stage: needs patch -> resolved status: pending -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue14845> _______________________________________

7 hours, 58 minutes

[issue21078] multiprocessing.managers.BaseManager.__init__'s "serializer" argument is not documented

by Yuriy Taraday

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.managers.BaseManager.__init__'s "serializer" argument is not documented versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21078> _______________________________________

8 hours, 20 minutes

[issue10936] Simple CSS fix for left margin at docs.python.org

by Christopher Dunn

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 currently gets smaller and smaller. But we need a compromise. The relevant CSS, in default.css, is this: div.bodywrapper { margin: 0 0 0 230px; } If instead it were something like this: div.bodywrapper { margin: 0 0 0 10%; } then at least the navigation margin would stay the same size always. If you really want it to grow and shrink, then you need some sort of javascript control of its position. ---------- assignee: docs@python components: Documentation messages: 126477 nosy: cdunn2001, docs@python priority: normal severity: normal status: open title: Simple CSS fix for left margin at docs.python.org type: behavior versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10936> _______________________________________

8 hours, 37 minutes

[issue42162] The license page for Python 3.0 is messed up

by MaT1g3R

New submission from MaT1g3R <peijun.ma(a)protonmail.com>: Page in question: https://docs.python.org/3.0/license.html The page still shows up in web searches (this is how I found the error) I tracked down the error to this commit, but I couldn't find a relevant branch to fix it: 4ca04b67f00edabe86072446f059adcb70eafcdd ---------- assignee: docs@python components: Documentation messages: 379692 nosy: MaT1g3R, docs@python priority: normal severity: normal status: open title: The license page for Python 3.0 is messed up type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42162> _______________________________________

9 hours, 3 minutes

[issue42042] docs.python.org for 3.10 missing the new refererence record.

by Dong-hee Na

New submission from Dong-hee Na <donghee.na92(a)gmail.com>: For example https://docs.python.org/3.10/c-api/bool.html?highlight=pydict_new#c.PyDict_… should display `Return value: New reference.` but not, this looks like a regression bug. other version display `Return value: New reference.` very well. ---------- assignee: docs@python components: Documentation messages: 378677 nosy: corona10, docs@python, vstinner priority: normal severity: normal status: open title: docs.python.org for 3.10 missing the new refererence record. versions: Python 3.10 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42042> _______________________________________

15 hours, 15 minutes

[issue42061] Document __format__ method for IPv[46]Address

by Eric V. Smith

New submission from Eric V. Smith <eric(a)trueblade.com>: This feature was added in issue 32820, but was never documented. ---------- assignee: docs@python components: Documentation keywords: easy, newcomer friendly messages: 378812 nosy: docs@python, eric.smith priority: normal severity: normal stage: needs patch status: open title: Document __format__ method for IPv[46]Address type: enhancement versions: Python 3.10, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42061> _______________________________________

1 day, 8 hours

[issue42194] BooleanOptionalAction missing "New in version 3.9"

by shangxiao

New submission from shangxiao <shang.xiao.sanders(a)gmail.com>: The section that describes BooleanOptionalAction just requires a "New in version 3.9" tag ---------- assignee: docs@python components: Documentation messages: 379867 nosy: docs@python, shangxiao priority: normal severity: normal status: open title: BooleanOptionalAction missing "New in version 3.9" versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42194> _______________________________________

1 day, 18 hours

[issue27886] Docs: the difference between rename and replace is not obvious

by Andrew Svetlov

New submission from Andrew Svetlov: Hi. On reading the doc for pathlib I've stuck with `.rename()` and `.replace()` (https://docs.python.org/3/library/pathlib.html#pathlib.Path.rename). What's the difference? Going to pathlib's source code I've figured out that methods are use different functions from `os` module: `os.rename()` and `os.replace()`. But the documentation for `os` module is not obvious too: the docs for both functions are almost equal from my perspective, the only significant difference is that `os.rename()` suggests to use `os.replace()` for cross-compatibility. Could anybody explain the difference? Also, at least the doc for `pathlib.Path.rename` worth to have a sentence like borrowed from `os.rename`: "If you want cross-platform overwriting of the destination, use replace()." ---------- assignee: docs@python components: Documentation keywords: easy messages: 273836 nosy: asvetlov, docs@python, pitrou priority: low severity: normal status: open title: Docs: the difference between rename and replace is not obvious type: behavior versions: Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue27886> _______________________________________

2 days, 12 hours

Jump to page:

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

docs