There was some discussion last week during the typing summit of putting together common documentation for the Python type system that is both type checker agnostic and more centralized than chasing down pieces of PEPs. This could also address some of the common concerns raised around providing context on type annotations in Python for developers new to the language, and where to get started in a world where more than one type checker exists. If we can get a documentation source that the larger Python community has contributed to and agrees on, I could see this providing a lot of value to new and existing users of types in the language.

 

I recall there was a suggestion during the summit to get this started as a subdirectory of the typing repository (https://github.com/python/typing), where we can incrementally iterate, then potentially moving a more finished version to somewhere discoverable alongside other python docs.

 

I’m curious to hear any thoughts or suggestions on the high level idea. Pending that, are there any concerns with getting started by creating a skeleton for common docs in the typing repository? I imagine just carving out a place to collaborate on this would be a helpful starting point, so incremental progress and discussion is possible. Is anyone interested in contributing, or have other suggestions around how to organize the effort?

 

I’ve posted a message with mostly the same content in the docs community issue that Carol started after the typing summit. This could also be a good place to continue the discussion in a way that’s more visible outside the typing mailing list: https://github.com/python/docs-community/issues/8

 

 

Shannon

_______________________________________________
Typing-sig mailing list -- typing-sig@python.org
To unsubscribe send an email to typing-sig-leave@python.org
https://mail.python.org/mailman3/lists/typing-sig.python.org/
Member address: jelle.zijlstra@gmail.com