On Apr 15, 2021, at 17:49, Luciano Ramalho <luci...@ramalho.org> wrote:

> Anyone who uses a language with support for static typing expects the
> language distribution to include a type checker. Since that may be
> beyond our means, then the least we could do is have some official
> guidance on the matter, maybe in the form of a "Typing HOWTO" as part
> of the official docs, and linked from the "typing" module docs.

Actually, I think it’s time for a comprehensive guide to type annotations.  
Just anecdotally, I was trying to annotate a library of mine and was having an 
impossible time of it, until a chat with Guido lead me to @typing.overload.  
That solved my problem intuitively and easily, but I just didn’t know about it. 
 Right now, there’s information spread out all over the place, the stdlib 
documentation, tool documentation, StackOverflow :D etc.  It’s a complicated 
topic that I think a comprehensive guide, a tutorial, etc. could really help 
with.

One of my favorite frameworks for thinking about documentation on a topic such 
as this is:

https://documentation.divio.com/

I really think that would help people get into Python type annotations, both 
casually and deeply.

> I volunteer to help with a "Typing HOWTO". For the next few months, I
> can offer to review if someone else writes it. In the second semester,
> I could write it myself, if the experts on typing and the type
> checkers would be willing to review it.

I don’t know whether I’ll have time to *start* something any time soon, but I 
would also volunteer to be a reviewer and/or provide some content.

-Barry

Attachment: signature.asc
Description: Message signed with OpenPGP

_______________________________________________
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/J56RVQHB76W5LY55OJ6NYS5KQXLKK7RJ/
Code of Conduct: http://python.org/psf/codeofconduct/

Reply via email to