search

python / typing

Python static typing home. Hosts the documentation and a user help forum.
https://typing.readthedocs.io/
Other
1.57k stars 231 forks source link

Should we add links to existing resources? #1046

Open stroxler opened 2 years ago

stroxler commented 2 years ago

I was catching up on a long python-dev discussion about the state of type annotations, and noticed that @gvanrossum had asked for a list of easily discoverable (by search engines) resources regarding typing.

I collected up this note: https://gist.github.com/stroxler/ade7977ed07e27448222a468796bc467

Would we want to include a couple of the best links (in particular the RealPython blog, maybe the LogRocket one as well) in our docs? At least at this time, those may actually be the two best getting-started tutorials. The mypy docs are much more thorough and incredibly useful as a reference, but aren't really written in a manner where a beginner could easily skim them end-to-end.

gvanrossum commented 2 years ago

I suggest opening a bpo issue and submitting a doc PR, or maybe just opening the bpo issue and ask if @Fidget-Spinner is interested.

srittau commented 2 years ago

I believe this is about the very rudamentary documentation at typing.readthedocs.io? In which case, we can just add the links in the repository here. PR welcome!

Fidget-Spinner commented 2 years ago

Like Guido said above, if you're interested in adding links to the typing docs at python.org, open an issue on the issue tracker and I'll land it! Adding it here is good too.

AlexWaygood commented 2 years ago

Linking to existing resources in both places sounds great.

Tbh I'd also love to see a typing HOWTO in the python.org docs (and would be happy to co-write it with someone if there's interest in that as an idea).

sobolevn commented 2 years ago

Shameless plug: we have a big collection of awesome typing-related things in Python. Maybe it is worth mentioning? https://github.com/typeddjango/awesome-python-typing/

stroxler commented 2 years ago

@sobolevn @srittau I'll send each of you a PR later this week

@Fidget-Spinner that sounds good, I'll open an issue and send a PR. I think we have to be a little more careful to only add high-quality links there, but I guess that's what the PR discussion is good for :)

stroxler commented 2 years ago

@AlexWaygood I have a lot of interest in helping to write more docs on typing.

I think that's what typing.readthedocs.io is meant to be for, I'd favor that over trying to put it in the python.org docs at least at first.

My biggest concern is that it's quite hard to document something as complicated as python typing well, so it may take us a while to have anything we consider better than the existing resource.