[issue24272] PEP 484 docs

[Berker Peksag]

Changes by Berker Peksag :


--
resolution:  -> fixed
stage: patch review -> resolved

___
Python tracker 

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

[issue24272] PEP 484 docs

[Berker Peksag]

Berker Peksag added the comment:

By the way, for some reason the changes in revision e361130782d4 are not in 
Doc/library/typing.rst.

For example,

io documentation on current default branch: 
https://hg.python.org/cpython/file/default/Doc/library/typing.rst#l376
io documentation on current 3.5 branch: 
https://hg.python.org/cpython/file/3.5/Doc/library/typing.rst#l376
Updates to the io documntation in revision e361130782d4: 
https://hg.python.org/cpython/rev/e361130782d4#l1.67

Also, my clone is up-to-date:

changeset:   97855:d433d74e0377
tag: tip
user:Victor Stinner 
date:Thu Sep 10 16:00:06 2015 +0200
files:   Python/pytime.c
description:
pytime: oops, fix typos on Windows

--

___
Python tracker 

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

I suck at merge. :-( No idea what happened. To fix it, I have now just
copied the file again from the larry branch and committed that in 3.5, then
merged up to 3.6 (default).

changeset:   97856:8a7814a3613b
branch:  3.5
parent:  97847:6c8e2c6e3a99
user:Guido van Rossum 
date:Thu Sep 10 10:52:11 2015 -0700
summary: Restore doc updates to typing.rst by Ivan Levkivskyi and
Daniel Andrade Groppe.

changeset:   97857:7fc4306d537b
tag: tip
parent:  97855:d433d74e0377
parent:  97856:8a7814a3613b
user:Guido van Rossum 
date:Thu Sep 10 10:54:10 2015 -0700
summary: Restore doc updates to typing.rst by Ivan Levkivskyi and
Daniel Andrade Groppe.

--

___
Python tracker 

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

[issue24272] PEP 484 docs

[Larry Hastings]

Larry Hastings added the comment:

Pull request accepted!  Please forward-merge, thanks!

--

___
Python tracker 

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

Merged and pushed. Let's please use a new issue for any further patches.

--
status: open -> closed

___
Python tracker 

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

[issue24272] PEP 484 docs

[Ivan Levkivskyi]

Ivan Levkivskyi added the comment:

Thank you, Guido!

I have noticed single quotes in line 38: 

type hinted using `Callable[[Arg1Type, Arg2Type], ReturnType]`

I think it would be logical to replace it with double quotes: 

``Callable[[Arg1Type, Arg2Type], ReturnType]`` 

as Zachary did in the rest of the text.

By the way, you have marked my patch as Daniels and vice versa in the commit 
descriptions, but that probably does not matter :)

--

___
Python tracker 

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

I apologize for the mix-up! The code review tool didn't help.

Regarding the single quotes, there seem to be a bunch more of these, and as 
cutting a PR is a fair bit of labor I'd rather not fix that. We can fix this 
once 3.5.0 it out of the door (hopefully this weekend).

--

___
Python tracker 

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

Pull Request: 
https://bitbucket.org/larry/cpython350/pull-requests/24/docs-update-for-typing-module/diff

--

___
Python tracker 

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

[issue24272] PEP 484 docs

[Ivan Levkivskyi]

Ivan Levkivskyi added the comment:

Guido, are you going to commit our patches before 3.5.final? Is there a merge 
conflict now? Should I rebase my diff?

If necessary I could make a clean patch combining two patches (my and Daniel's) 
on top of what Zachary did.

--

___
Python tracker 

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

I apologize, I've been distracted. I will try to get to this before 3.5.0 final 
goes out! I don't know if the fixes will end up in the tar ball but they will 
certainly be on docs.python.org.

--

___
Python tracker 

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

[issue24272] PEP 484 docs

[Roundup Robot]

Roundup Robot added the comment:

New changeset 192c654a7c93 by Zachary Ware in branch '3.5':
Issue #24272: Remove usage of default reST role from typing docs
https://hg.python.org/cpython/rev/192c654a7c93

New changeset 10a63ded324c by Zachary Ware in branch 'default':
Issue #24272: Merge with 3.5
https://hg.python.org/cpython/rev/10a63ded324c

--

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

[issue24272] PEP 484 docs

[Daniel Andrade Groppe]

Daniel Andrade Groppe added the comment:

Here's a patch for the second half of remaining classes (this file is a 
complement of Ivan Levkivskyi's patch).

--

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

[issue24272] PEP 484 docs

[Daniel Andrade Groppe]

Daniel Andrade Groppe added the comment:

Missing Generator.

--
Added file: http://bugs.python.org/file40161/typying_documentation_part2.patch

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

Yeah, there's another diff but I didn't get to it.

--

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

[issue24272] PEP 484 docs

[Larry Hastings]

Changes by Larry Hastings la...@hastings.org:


--
priority: release blocker - high

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

[issue24272] PEP 484 docs

[Larry Hastings]

Larry Hastings added the comment:

I assume what we've got is good enough for rc1?

Can we mark this closed / reduce the priority from release blocker?

Note that there are few (if any) restrictions on fixing docs during the release 
candidates.  (Though after today we'll be switching to the Bitbucket pull 
request workflow, so that will complicate matters slightly.)

--
nosy: +larry

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

[issue24272] PEP 484 docs

[Ivan Levkivskyi]

Ivan Levkivskyi added the comment:

Here is a new patch for the first part of classes at the end of docs.
I also did some minor changes (in particular added more info on generics and 
removed the section about ellipsis for default arguments, we could return it if 
we decide to write something about stub files here).

--
Added file: http://bugs.python.org/file40144/typedoc_new.patch

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

[issue24272] PEP 484 docs

[Roundup Robot]

Roundup Robot added the comment:

New changeset a8dcbd2711d6 by Guido van Rossum in branch '3.5':
Issue #24272: Initial docs for typing.py (PEP 484).
https://hg.python.org/cpython/rev/a8dcbd2711d6

New changeset 0c74fd4219aa by Guido van Rossum in branch 'default':
Issue #24272: Initial docs for typing.py (PEP 484). (Merge from 3.5.)
https://hg.python.org/cpython/rev/0c74fd4219aa

--
nosy: +python-dev

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

I've landed this now (for real). Next time please strip all trailing whitespace 
from typing.rst, else the hg push fails!

--

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

[issue24272] PEP 484 docs

[Daniel Andrade Groppe]

Daniel Andrade Groppe added the comment:

@Ivan, I'll work on the remaining half.

--

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

[issue24272] PEP 484 docs

[Mark Shannon]

Changes by Mark Shannon m...@hotpy.org:


--
nosy: +Mark.Shannon

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

Thank you Ivan! I am going to commit this, it's much better than the two lines 
we had before. :-) There's still a lot of work left to do -- towards the end 
there are many classes without description. Maybe you and Daniel can divide up 
the work for those? We can always iterate (even during the release candidates 
and even after the 3.5.0 release).

--

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Guido van Rossum added the comment:

This should probably be committed before RC1 -- it's better than nothing!

--
priority: normal - release blocker

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

[issue24272] PEP 484 docs

[Daniel Andrade Groppe]

Daniel Andrade Groppe added the comment:

I dropped the ball here. The last message from the review system was 
misclassified by Gmail as spam... Sorry about that.

I can take a look at this tonight but if anyone can address the comments 
earlier, go for it.

--

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

[issue24272] PEP 484 docs

[Ivan Levkivskyi]

Ivan Levkivskyi added the comment:

Is anyone working on this right now? If not, I could implement the comments by 
Guido to the latest patch by Daniel.

--

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

[issue24272] PEP 484 docs

[Ivan Levkivskyi]

Ivan Levkivskyi added the comment:

New version of the patch by Daniel, latest comments by Guido are taken into 
account.

--
Added file: http://bugs.python.org/file40108/typing_doc_v3.patch

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

[issue24272] PEP 484 docs

[Berker Peksag]

Changes by Berker Peksag berker.pek...@gmail.com:


--
nosy: +berker.peksag
stage: needs patch - patch review
versions: +Python 3.6

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

[issue24272] PEP 484 docs

[Ivan Levkivskyi]

Changes by Ivan Levkivskyi levkivs...@gmail.com:


--
nosy: +levkivskyi

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

[issue24272] PEP 484 docs

[Daniel Andrade Groppe]

Daniel Andrade Groppe added the comment:

A first iteration of the documentation based on the PEP and the module source.

This still needs a lot of work.

--
keywords: +patch
nosy: +Daniel.Andrade.Groppe
Added file: http://bugs.python.org/file39484/typing_doc.patch

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

[issue24272] PEP 484 docs

[Daniel Andrade Groppe]

Daniel Andrade Groppe added the comment:

Addressing comments from the review. Here is an updated patch.

--
Added file: http://bugs.python.org/file39487/typing_doc_v2.patch

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

[issue24272] PEP 484 docs

[Guido van Rossum]

Changes by Guido van Rossum gu...@python.org:


--
stage:  - needs patch
type:  - enhancement

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

[issue24272] PEP 484 docs

[Guido van Rossum]

New submission from Guido van Rossum:

Would be nice if there were more docs for the typing module (PEP 484). Looking 
for volunteers. (There's stuff in the PEP that can serve as a starting point.)

Note: support for isinstance() and issubclass() will be withdrawn in beta 2.

--
assignee: docs@python
components: Documentation
messages: 243945
nosy: docs@python, gvanrossum
priority: normal
severity: normal
status: open
title: PEP 484 docs
versions: Python 3.5

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