python / typing-council

Decisions by the Python Typing Council
41 stars 3 forks source link

Adopt the initial Python typing spec #3

Closed JelleZijlstra closed 8 months ago

JelleZijlstra commented 9 months ago

I am asking the Typing Council to adopt the typing spec I put together: https://github.com/python/typing/pull/1517.

This is being discussed in https://discuss.python.org/t/proposed-initial-typing-spec/39389.

erictraut commented 9 months ago

I skimmed the document. It's a great starting point for the typing spec.

I didn't do a detailed comparison of the text to the original PEPs, but I presume that it's largely a verbatim copy of the specification sections of the original PEPs. If there are specific sections that you think require more careful review, please let us know.

JelleZijlstra commented 8 months ago

I'm not sure there's anything that I feel is more tricky. To see how I put it together, check the commits in https://github.com/JelleZijlstra/typing-spec/commits/main, and also the individual commits in https://github.com/JelleZijlstra/typing-spec/pull/16 where I moved everything around according to your suggested outline.

A couple of the introductory sections have a bit more text that I didn't lift directly from the PEPs, e.g. the overall introduction in https://draft-typing-spec.readthedocs.io/en/latest/type-system.html.

A few commits that didn't come directly from the PEPs:

The section on generics (https://draft-typing-spec.readthedocs.io/en/latest/generics.html) could use some more reorganization.

erictraut commented 8 months ago

Thanks. I reviewed all of the sections that were linked above, and they all look good to me.

I agree the generics section would benefit from additional organization, but I think that can wait for subsequent passes on the document.

rchen152 commented 8 months ago

+1 This is a good starting point, and overall, I like the new organization.

hauntsaninja commented 8 months ago

I think this is a great place to start!

gvanrossum commented 8 months ago

+1. This is a great basis to iterate.

JelleZijlstra commented 8 months ago

Thanks, that makes everyone. I will merge the spec and we can start making improvements.