Repository navigation
Rewrite typing.Annotated docs #124269
Description
As @JelleZijlstra said in #124125
I don't like this long bulleted list of individual issues. We should rewrite it to a more organized form.
typing.Annotated indeed has a lot bullet points in the docs: https://docs.python.org/3/library/typing.html#typing.Annotated
So, how can we be more compact about it while keeping all the details?
Activity
picnixz commentedon Sep 20, 2024
How about grouping some features and the examples? There are some bullet points that don't have examples so they could be moved out in a paragraph directly.
Interaction with
get_type_hintsmay be a separate paragraph as well. And limitations on duplication and metadata order could be grouped.Finally the runtime behaviour should be a separate paragraph as well.
It doesn't reduce the length of the docs (it will be probably increased) but you won't have bullet points anymore that are indigest.
gh-124269: Simplify `typing.Annotated` docs (#130770)
pythongh-124269: Simplify `typing.Annotated` docs (pythonGH-130770)
pythongh-124269: Simplify `typing.Annotated` docs (pythonGH-130770)
[3.13] gh-124269: Simplify `typing.Annotated` docs (GH-130770) (#131222)
[3.12] gh-124269: Simplify `typing.Annotated` docs (GH-130770) (#131223)
[3.12] pythongh-124269: Simplify `typing.Annotated` docs (pythonGH-13…
pythongh-124269: Simplify `typing.Annotated` docs (python#130770)