Mailman 3 July 2016 - docs

[issue27579] Add a tutorial for AsyncIO in the documentation
by Stéphane Wirtel 26 Jul '16

26 Jul '16

New submission from Stéphane Wirtel: The documentation of AsyncIO is well written for a developer, but it's a reference. We have the description of all the methods, classes, etc... But we want to learn to develop with AsyncIO, it's difficult, because there is no many examples in this reference and we have to look for some examples on Internet. Could we add a AsyncIO tutorial|cookbook|howto ? because we have a "Logging Cookbook" but not a "AsyncIO 101". Thank you Stephane ---------- assignee: docs@python components: Documentation messages: 270876 nosy: asvetlov, docs@python, haypo, matrixise, yselivanov priority: normal severity: normal status: open title: Add a tutorial for AsyncIO in the documentation versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27579> _______________________________________

5 8

[issue27618] docs for threading.Lock claim it's a class (since 3.3), but it's not (and has never been, apparently)
by Guido van Rossum 25 Jul '16

25 Jul '16

Changes by Guido van Rossum <guido(a)python.org>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python versions: +Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27618> _______________________________________

1 0

Re: [docs] Patch to enhance literal block language declaration (issue 26462)
by vadmium+py＠gmail.com 25 Jul '16

25 Jul '16

http://bugs.python.org/review/26462/diff/16666/Doc/whatsnew/3.2.rst File Doc/whatsnew/3.2.rst (right): http://bugs.python.org/review/26462/diff/16666/Doc/whatsnew/3.2.rst#newcode… Doc/whatsnew/3.2.rst:2048: .. code-block:: none On 2016/03/01 23:15:32, Zach Ware wrote: > This can be 'doscon' instead of 'none'. FWIW this still produces a warning for me (but maybe it is beneficial if Sphinx knows about “doscon”): /media/disk/home/proj/python/cpython/Doc/whatsnew/3.2.rst:2050: WARNING: Pygments lexer name 'doscon' is not known http://bugs.python.org/review/26462/

1 0

Python Documentation - EPUB Download
by Bruno Clementi 25 Jul '16

25 Jul '16

Hello! I'm currently learning python and I'm using the documentation to consult specific topics, but I also would like to read it, studying it as a "text" book, and one of the reasons that I don't do it as much as I otherwise would, is because it is difficult to read it on my smarphone or tablet, because I have to constatly adjust the text in order to fit the text to the screen. I tried taking the pdf and converting it to EPUB, but it never comes out right and the coding part, which would be better to read by opening it as an image, is always the worst formatted part. That being said, one suggestion I would make, specially taking into account the widespread use of smartphones, tablets and ereaders today and since you already have different times of formats for the documentation to be downloaded, would be to add the option to download the documentation on epub format. Thank you for the time and attention. Bruno Clementi

1 0

[issue19198] Improve cross-references in cgi documentation
by Serhiy Storchaka 25 Jul '16

25 Jul '16

New submission from Serhiy Storchaka: Here is a patch which fixes internal references in the documentation of the cgi module. ---------- assignee: docs@python components: Documentation files: refs.cgi.patch keywords: patch messages: 199249 nosy: docs@python, serhiy.storchaka priority: normal severity: normal stage: patch review status: open title: Improve cross-references in cgi documentation type: enhancement versions: Python 2.7, Python 3.3, Python 3.4 Added file: http://bugs.python.org/file32006/refs.cgi.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19198> _______________________________________

2 3

[issue27601] Minor inaccuracy in hash documentation
by Aleksandr Koshkin 25 Jul '16

25 Jul '16

New submission from Aleksandr Koshkin: https://docs.python.org/3.6/library/stdtypes.html#hashing-of-numeric-types Look at semantics example for hash_complex function. The variable 'hash' is clearly misused - it is not defined or refers to builtin function 'hash'. Either way the example is incorrect. ---------- assignee: docs@python components: Documentation messages: 271097 nosy: docs@python, magniff priority: normal severity: normal status: open title: Minor inaccuracy in hash documentation versions: Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27601> _______________________________________

8 14

[issue27597] Add usage examples for TracebackException, StackSummary and FrameSummary
by Ram Rachum 23 Jul '16

23 Jul '16

New submission from Ram Rachum: I saw these new interesting classes in the `traceback` docs, but if I were shown an example of how they are used, I might get inspired to use them in my own code. ---------- assignee: docs@python components: Documentation messages: 271072 nosy: cool-RR, docs@python priority: normal severity: normal status: open title: Add usage examples for TracebackException, StackSummary and FrameSummary type: enhancement versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27597> _______________________________________

1 0

[issue23320] devguide should mention rules about "paragraph reflow" in the documentation
by Brett Cannon 22 Jul '16

22 Jul '16

Brett Cannon added the comment: Moved to https://github.com/python/devguide/issues/12 ---------- nosy: +brett.cannon resolution: -> out of date status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23320> _______________________________________

1 0

[issue10965] dev task of documenting undocumented APIs
by Brett Cannon 22 Jul '16

22 Jul '16

Brett Cannon added the comment: Moved to https://github.com/python/devguide/issues/10 ---------- resolution: -> out of date status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10965> _______________________________________

1 0

[issue25393] 'resource' module documentation error
by Χρήστος Γεωργίου (Christos Geo rgiou) 19 Jul '16

19 Jul '16

New submission from Χρήστος Γεωργίου (Christos Georgiou): https://docs.python.org/3.5/library/resource.html https://docs.python.org/3.5/library/resource.html#resource.RLIMIT_FSIZE ends with the sentence "This only affects the stack of the main thread in a multi-threaded process." I believe this sentence should be appended to https://docs.python.org/3.5/library/resource.html#resource.RLIMIT_STACK This error also exists in previous versions of python documentation. ---------- assignee: docs@python components: Documentation messages: 252935 nosy: docs@python, tzot priority: normal severity: normal status: open title: 'resource' module documentation error type: enhancement versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25393> _______________________________________

6 5