PEP 727: Documentation Metadata in Typing

[tiangolo]

Add PEP 727: Documentation Metadata in Typing

---

📚 Documentation preview 📚: https://pep-previews--3310.org.readthedocs.build/

[JelleZijlstra]

Looks good! The comment about Sphinx isn't blocking for getting the PEP merged, but buy-in from Sphinx would make the PEP stronger.

[tiangolo]

Thanks a lot @JelleZijlstra! That was so fast. 🤯

I know very little about Sphinx, but if @AA-Turner could help me or point me in the right direction, I would definitely try to find a way to make it happen.

[tiangolo]

Thanks for merging @JelleZijlstra!

I guess you can imagine my proud and happy smile right now (even if this never gets approved). I feel like a kid graduating or something. 😊

[PIG208]

Amazing @tiangolo! Maybe we can start a thread at https://discuss.python.org/c/peps/19 for community discussions (and to also fill the discussion-to field)?

[tiangolo]

Yes @PIG208! I was waiting to have it available in typing_extensions (I have the PR here: python/typing_extensions#277) as that is mentioned in the PEP, and it could be confusing if people tried it and didn't find it.

But now I'm not sure I should just start the thread right away... I'll wait for @JelleZijlstra's opinion and then I'll make the thread depending on that. 🤓

[JelleZijlstra]

It's fine to open the discussion now. I'll take a look at the typing-extensions PR tonight and hopefully merge it and cut a release.

[tiangolo]

Great, thank you @JelleZijlstra!

I just created the discussion here: https://discuss.python.org/t/pep-727-documentation-metadata-in-typing/32566

[AA-Turner]

Hi @tiangolo, thanks for the PEP. I've reviewed in-line here. I'll open a PR to address some of the more editorial points of my review.

Thanks,
Adam

[tiangolo]

Thanks a lot for the thorough review and sincere feedback @AA-Turner, in particular, thanks for giving all that feedback without any negative emotion (e.g. sarcastic criticism, derogatory comments, etc.). 🙇

I think it makes sense to merge #3316 first and then I'll work on anything else missing from your review.

Then I'll also work on the updates from other feedback, how other languages do, and a lot of Eric Traut's comments.