docs November 2016

docs@python.org

16 participants
577 discussions

Document recen changes in typing.py (issue 28644)
by guido＠python.org 09 Nov '16

09 Nov '16

Thanks for working on this! Couple of requests. http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst File Doc/library/typing.rst (right): http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst#newco… Doc/library/typing.rst:14: fundamental support consists of the type :data:`Any`, :data:`Union`, type -> types http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst#newco… Doc/library/typing.rst:283: def response(query: str) -> Response[str]: # Same as Union[Iterable[str], int] Can you break up this line? Long lines in doc examples often look bad or cause horizontal scrolling. Maybe put the comment on the line before (adding "Return type here is same as ..."). http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst#newco… Doc/library/typing.rst:444: .. class:: Tuple I'm not sure I'm comfortable advertising Tuple as a class. While `class C(Tuple): pass` works, using `class C(Tuple[int, int]): pass` elicits the error (from mypy) "error: Tuple[...] not supported as a base class outside a stub file". http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst#newco… Doc/library/typing.rst:457: .. class:: Callable This is even more dubious as a class, `class C(Callable)` gives "Invalid base class" and so does `class C(Callable[..., int])`. I really want to limit Callable and Tuple to just being types usable in annotations, not runtime building blocks. http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst#newco… Doc/library/typing.rst:463: must be a list of types; the return type must be a single type. This is contradicted later, the arglist can also be an ellipsis. http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst#newco… Doc/library/typing.rst:629: .. class:: Coroutine(Awaitable[V_co], Generic[T_co T_contra, V_co]) This one OTOH *is* a real class and can be subclassed etc. (Even though in practice it's still most useful in annotations, since few people will have reason to implement their own coroutines -- they'll just define a generator.) http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst#newco… Doc/library/typing.rst:636: c = None # type: Coroutine[List[str], str, int] Can you also show an example of how one would create an object of this type? I think it's what you get when you call an async def. http://bugs.python.org/review/28644/diff/19105/Doc/library/typing.rst#newco… Doc/library/typing.rst:770: collected in superclasses following ``obj.__mro__``. Probably also add that for a class C, it's *not* just C.__annotations__, but rather a dict constructed by merging all the __annotations__ dicts along C.__mro__ (in reverse order, if you want to be precise). http://bugs.python.org/review/28644/

1 0

Re: [docs] Broken Link
by Sophie Hunt 08 Nov '16

08 Nov '16

Hi, I know you're busy so I just wanted to follow up on the email I sent you the other day as I noticed the link is still broken. I've included my email below for reference: On Fri, Oct 28, 2016 at 8:48 AM, Sophie Hunt <sophie.hunt(a)ctechemail.com> wrote: Hi, I recently came across a link on your site which appears to be broken. Here's the link http://csrc.nist.gov/encryption/tkhash.html, found on this page of your site http://davis.lbl.gov/Manuals/PYTHON-2.5.1/lib/module-sha.html. I thought that you may wish to check out our guide [https://www.comparitech.com/blog/information-security/cryptography-guide/] as it may make a suitable replacement. I hope this helps! Sophie

2 1

[issue28088] Document Transport.set_protocol and get_protocol
by Mariatta Wijaya 07 Nov '16

07 Nov '16

New submission from Mariatta Wijaya: Added the documentation for set_protocol and get_protocol. ---------- keywords: +patch Added file: http://bugs.python.org/file44918/issue28088.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28088> _______________________________________

5 10

[issue8840] truncate() semantics changed in 3.1.2
by Berker Peksag 07 Nov '16

07 Nov '16

Berker Peksag added the comment: The patch looks good to me, but perhaps we should make these docstrings shorter and refer people to the actual documentation for details? We recently did this in subprocess and venv modules. ---------- nosy: +berker.peksag, martin.panter stage: needs patch -> patch review versions: +Python 3.6, Python 3.7 -Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8840> _______________________________________

1 0

example to add to documentation "xml.sax"
by Bryan Hutson 07 Nov '16

07 Nov '16

Assuming I'm emailing the right people I found an example that I think could help out the "xml.sax" ( https://docs.python.org/2/library/xml.sax.html) documentation. The example is from stack overflow and will run as is. I'm not the author but it's a great sample of code. http://stackoverflow.com/a/22504625/2601293 thanks, Bryan

1 0

Update encoding lookup docs wrt #27938 (issue 28393)
by angwerzx＠126.com 07 Nov '16

07 Nov '16

http://bugs.python.org/review/28393/diff/18859/Doc/library/codecs.rst File Doc/library/codecs.rst (right): http://bugs.python.org/review/28393/diff/18859/Doc/library/codecs.rst#newco… Doc/library/codecs.rst:974: dashes. Using alternative aliases for these encodings may result in slower Lack iso8859-1. And since there is utf8, also lacking utf16 and utf32. http://bugs.python.org/review/28393/

1 0

[issue11368] Document why xml.etree.ElementTree.Element has no reference to parent
by A.M. Kuchling 06 Nov '16

06 Nov '16

A.M. Kuchling added the comment: Closing this old issue. ---------- nosy: +akuchling status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11368> _______________________________________

1 0

[issue8840] truncate() semantics changed in 3.1.2
by A.M. Kuchling 06 Nov '16

06 Nov '16

A.M. Kuchling added the comment: "Why, this is a simple docstring change. How difficult can it be?", I thought. Ah ha ha ha. Here's a patch against the 3.5 branch. It should also apply cleanly to 3.6 or 3.7, except for a little Argument Clinic noise. The patch changes 3 occurrences of the truncate() docstring in Lib/_pyio.py, and 1 each in Modules/_io/{bytesio.c,fileio.c,iobase.c,stringio.c}. Whew! Do we want to change all of these occurrences, or just the one specific case of StringIO? It seemed to me that we want to change them all. ---------- nosy: +akuchling Added file: http://bugs.python.org/file45375/issue8840.txt _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8840> _______________________________________

1 0

[issue21864] Error in documentation of point 9.8 'Exceptions are classes too'
by Peibolvig 06 Nov '16

06 Nov '16

New submission from Peibolvig: At point 9.8 of the 3.4.1 version documentation, ( https://docs.python.org/3/tutorial/classes.html#exceptions-are-classes-too ), there is an example of two ways to use the 'raise' statement: raise Class raise Instance The next two lines, state: "In the first form, Class must be an instance of type or of a class derived from it. The first form is a shorthand for: raise Class()" That only says something about the first form twice. I think that the correct way would be: "In the first form, Class must be an instance of type or of a class derived from it. The SECOND form is a shorthand for: raise Class()" ---------- assignee: docs@python components: Documentation messages: 221511 nosy: Peibolvig, docs@python priority: normal severity: normal status: open title: Error in documentation of point 9.8 'Exceptions are classes too' versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21864> _______________________________________

6 9

[issue28590] fstring's '{' from escape sequences does not start an expression
by Eric V. Smith 06 Nov '16

06 Nov '16

Eric V. Smith added the comment: Thanks, Jason. I updated the PEP, so now I think the docs and PEP match the implementation. ---------- resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28590> _______________________________________

1 0

Jump to page:

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

docs November 2016