You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Since we're starting to plan a 1.0 release, I'm taking the opportunity to do a pass over the mypy docs.
Some overarching goals include:
Increase consistency. It's pretty common to see multiple places in the mypy docs where we talk about the same thing in different ways.
In particular, the command line and config file reference often diverge in ways that are surprising to users and contributors (we should maybe unify these entirely)
Fix up out of date references. In various places, things are slightly out of date in 2022.
Make changes with a global view of the docs. Various sections have accreted information over time. Splitting out, reordering and relinking things can make things more accessible to newcomers to the type system and lend a sense of progression as you read through the docs.
Make things more accessible. The mypy docs are the best Python type system reference out there, so it's important to make sure we continue to serve newcomers well
I'm not planning on proactively explaining all my changes in each PR, but if you're reviewing them, please feel free to ask why I changed something.
It's been a year since I opened this, closing. I'll still make docs improvements, but 1.0 has been out for a while, so there isn't a specific target any more.
Activity
Major update to "using mypy with existing codebase"
Update cheat sheet docs (#13679)
Major update to "using mypy with existing codebase" (#13683)
Update runtime_troubles docs (#13680)
Mention files confval in "specifying code to check" (#13682)
Update getting started docs
Update type inference and annotations
Update getting started docs (#13734)
Talk about user defined protocols first
Reorder sections in running_mypy
Update type inference and annotations (#13736)
Reorder sections in running_mypy (#13738)
Improve cheat sheet
12 remaining items
Improve protocols documentation (#14577)
Improve Generics docs page (#14587)
More improvements to getting started docs (#14572)
Improve some dynamic typing docs (#14576)
Make a top-level TypedDict page (#14584)
Improve the Common Issues page (#14581)
Improve protocols documentation (#14577)
Improve Generics docs page (#14587)
Improvements to cheat sheet
Improve async documentation
Improve async documentation (#14973)
Improvements to cheat sheet (#14972)
Small improvements to protocol documentation
hauntsaninja commentedon Aug 10, 2023
It's been a year since I opened this, closing. I'll still make docs improvements, but 1.0 has been out for a while, so there isn't a specific target any more.