gh-124269: Simplify typing.Annotated docs
#130770
Conversation
StanFromIreland
requested review from
JelleZijlstra and
AlexWaygood
as code owners
bedevere-app
bot
added
docs
|
I forgot about this one. If Jelle approves the PR today, go ahead and merge it, or I'll review it tomorrow. |
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
JelleZijlstra
added
needs backport to 3.12
@picnixz friendly ping :-) |
|
I'm currently travelling so I don't have time to review sorry. Nikita/Alex could also review the PR but I trust Jelle's judgment on this one so if he wants to merge it, go ahead. I can review it when I'm at the airport in a few hours though |
| * At runtime, the metadata associated with an ``Annotated`` type can be | ||
| retrieved via the :attr:`!__metadata__` attribute: | ||
| At runtime, the metadata associated with an ``Annotated`` type can be | ||
| retrieved via the :attr:`!__metadata__` attribute. If you want to retrieve |
There was a problem hiding this comment.
To avoid mixing examples, I would prefer a separate paragraph for origin, namely;
Paragraph for metadata
Example
One line of text for origin
Example
Or at least two distinct doctest blocks.
|
|
||
| * The order of the metadata elements is preserved and matters for equality | ||
| checks:: | ||
| assert a1 != a2 # Order matters |
There was a problem hiding this comment.
| assert a1 != a2 # Order matters | |
| assert a1 != a2 # Order matters |
| .. doctest:: | ||
|
|
||
| >>> from typing import Annotated, get_origin |
There was a problem hiding this comment.
I think this import is still needed but I'm not entirely sure. Because Annotated may not be imported when executing the block test
Grouped relevant bullet points into paragraphs. Maybe I took too many creative liberties...
Request: @JelleZijlstra @sobolevn @picnixz
typing.Annotateddocs #124269