Mailman 3 December 2019 - docs

[issue18697] Unify arguments names in Unicode object C API documentation
by Serhiy Storchaka Dec. 9, 2019

Dec. 9, 2019

New submission from Serhiy Storchaka: In declarations of Unicode object C API functions in Doc/c-api/unicode.rst the first Unicode object argument has different names: "unicode", "str", "u", "s". It will be good to unify these names. Of course there is no need to change reasonable argument names for such functions as PyUnicode_Concat() or PyUnicode_CopyCharacters(). ---------- assignee: docs@python components: Documentation, Unicode keywords: easy messages: 194755 nosy: docs@python, ezio.… [View More]

8 17

Bug report: regarding the write() method
by Christos Vasilakos Dec. 9, 2019

Dec. 9, 2019

Dear sir or madam, We are students of the University of Ioannina in the Department of Computer Engineering and Computer Science and during our lecture we, together with our professor(Nikos Mamoulis), came across an interesting case on the subject of file writing in Python 3. Upon opening a file with 'r+', and then proceeding to read from it, when attempting to write in the same file, the write() method does not obey the "cursor" position in the said file which was set by the read method, … [View More]

1 0

[issue38652] Remove/update provisional note for asyncio.BufferedProtocol
by Kyle Stanley Dec. 7, 2019

Dec. 7, 2019

New submission from Kyle Stanley <aeros167(a)gmail.com>: In the documentation (https://docs.python.org/3.9/library/asyncio-protocol.html#buffered-streamin…) for asyncio.BufferedProtocol there is a provisional API note. This should be updated/removed for 3.8 and 3.9 since it became a part of the stable API in 3.8. Current: > New in version 3.7: Important: this has been added to asyncio in Python 3.7 on a provisional basis! This is as an experimental API that might be changed or … [View More]

6 10

Errors in the "Python Patterns - Implementing Graphs" essay
by Fadil Nohur Dec. 6, 2019

Dec. 6, 2019

Hello there, I would like to report some issues in the "Python Patterns - Implementing Graphs" Python essay, which can be found here: https://www.python.org/doc/essays/graphs/ . The first issue I would like to report is a Py2/Py3 incompatibility issue. The first 3 functions in the essay; find_path(), find_all_paths() and find_shortest_path(); all use the line if not graph.has_key(start) . In these functions, graph is a dictionary. However, the has_keys() method has been removed from Python 3, … [View More]

1 0

https://docs.python.org/3/library/random.html
by A N Dec. 5, 2019

Dec. 5, 2019

The random section doesnt include "from random import randrange" anywhere before giving a bunch of examples that includes randrange. I figured it out after searching around the web, but that'd be super confusing for a new guy, please fix.

1 0

[issue9694] argparse required arguments displayed under "optional arguments"
by Géry Dec. 3, 2019

Dec. 3, 2019

Géry <gery.ogam(a)gmail.com> added the comment: I have just run into the same issue here: https://bugs.python.org/issue38950 - I prefer Terry J. Reedy's "keyword arguments" as it is clear and consistent with "positional arguments". - But Steven Bethard 's "flag arguments" looks fine since it is well known to shell users. - Martin Panter's "options" looks okay since it is the standard name in GNU Coreutils (https://www.gnu.org/software/coreutils/manual/coreutils.html#Common-options). … [View More]

1 0

[issue34344] Fix the docstring for AbstractEventLoopPolicy.get_event_loop
by Vlad Starostin Dec. 2, 2019

Dec. 2, 2019

New submission from Vlad Starostin <drtyrsa(a)yandex.ru>: The docstring says "This may be None or an instance of EventLoop". But docs explicitly state that get_event_loop "must never return None". The same docstring is also in the example in docs: https://docs.python.org/3.6/library/asyncio-eventloops.html#customizing-the… I propose changing it to: def get_event_loop(self): """Get the event loop. Returns an instance of EventLoop or raises an exception. """ If the wording … [View More]

7 13

[issue37883] threading.Lock.locked is not documented
by Rémi Lapeyre Dec. 1, 2019

Dec. 1, 2019

New submission from Rémi Lapeyre <remi.lapeyre(a)henki.fr>: As far as I can tell, it has never been documented. I'm not sure if it is deprecated but it has a docstring so it seems to me, that it just needs documentation in Doc/Library/threading.rst PS: I don't know how to set the beginner friendly flag. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 349923 nosy: docs@python, remi.lapeyre priority: normal severity: normal status: open title: … [View More]

5 16

[issue28805] Add documentation for METH_FASTCALL
by Stefan Krah Dec. 1, 2019

Dec. 1, 2019

New submission from Stefan Krah: It looks like METH_FASTCALL gives nice speedups (#28754). Is this an internal interface or can it be documented like METH_KEYWORDS etc.? ---------- assignee: docs@python components: Documentation messages: 281766 nosy: docs@python, haypo, serhiy.storchaka, skrah priority: normal severity: normal stage: needs patch status: open title: Add documentation for METH_FASTCALL type: enhancement versions: Python 3.6 _______________________________________ Python … [View More]

8 16