[issue26141] typing module documentation incomplete

[Roundup Robot]

Roundup Robot added the comment:

New changeset 7187d167abe8 by Guido van Rossum in branch 'default':
Issue #26141: Update docs for typing.py. Ivan Levkivskyi.
https://hg.python.org/cpython/rev/7187d167abe8

New changeset 1dc45beca118 by Guido van Rossum in branch '3.5':
Issue #26141: Update docs for typing.py. Ivan Levkivskyi. (Backport from the 
3.6 version)
https://hg.python.org/cpython/rev/1dc45beca118

New changeset 960a73507d4d by Guido van Rossum in branch 'default':
Issue #26141: Update docs for typing.py. Ivan Levkivskyi. (null merge 3.5->3.6)
https://hg.python.org/cpython/rev/960a73507d4d

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26141] typing module documentation incomplete

[Guido van Rossum]

Guido van Rossum added the comment:

Thanks!

--
resolution:  -> fixed
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26141] typing module documentation incomplete

[Guido van Rossum]

Guido van Rossum added the comment:

I'll figure it out.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26141] typing module documentation incomplete

[Ivan Levkivskyi]

Ivan Levkivskyi added the comment:

The patch contains docs for both new 3.6 features and missing 3.5:

ClassVar, Collection, plus also Sized, Hashable, DefaultDict, @overload, 
TYPE_CHECKING

Should I generate a separate patch for 3.5 with only 3.5 omissions?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26141] typing module documentation incomplete

[Guido van Rossum]

Guido van Rossum added the comment:

Most things mentioned by Ben have been added (thanks Michael Lee!), but it 
seems the 3.5 docs and the 3.6 docs have deviated more than they ought to. I 
guess updating the 3.6 docs is more urgent because of the upcoming 3.6b1 
release. I'll look later.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26141] typing module documentation incomplete

[Ivan Levkivskyi]

Ivan Levkivskyi added the comment:

Here is the patch for some omissions in typing module documentation.

Guido, please take a look.

--
keywords: +patch
nosy: +gvanrossum
Added file: http://bugs.python.org/file44541/typing-doc.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26141] typing module documentation incomplete

[Ivan Levkivskyi]

Ivan Levkivskyi added the comment:

I would like to do this (update the typing docs) at some point before 3.6 
beta1. There probably will be some updates to the PEP (it is still 
provisional), and maybe to typing.py soon.

--
nosy: +levkivskyi

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26141] typing module documentation incomplete

[Berker Peksag]

Changes by Berker Peksag :


--
nosy: +berker.peksag
stage:  -> needs patch
type:  -> enhancement
versions: +Python 3.6

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26141] typing module documentation incomplete

[Ben Darnell]

New submission from Ben Darnell:

The typing module docs at https://docs.python.org/3/library/typing.html do not 
include everything that is documented in the PEP 
(https://www.python.org/dev/peps/pep-0484/#the-typing-module). Specifically, 
`AnyStr` is mentioned but not defined, the `@overload` decorator is missing, 
and so are the new-to-3.5 types Awaitable, AsyncIterable, AsyncIterator.

--
assignee: docs@python
components: Documentation
messages: 258475
nosy: Ben.Darnell, docs@python
priority: normal
severity: normal
status: open
title: typing module documentation incomplete
versions: Python 3.5

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com