gh-86139: Keep TypedDict and NamedTuple in class role in docs
#143702
Conversation
Partially reverts pythonGH-143692; see python#143692 (comment)
johnslavik
added
needs backport to 3.13
| types. | ||
|
|
||
| .. function:: NamedTuple | ||
| .. class:: NamedTuple |
There was a problem hiding this comment.
does this one need to change? I don't think we have any attributes documented for NamedTuple with the .. attribute:: syntax
There was a problem hiding this comment.
| .. class:: NamedTuple | |
| .. function:: NamedTuple |
There was a problem hiding this comment.
What if this changes in the future, and we would then need to change the type again? My only concern is that changing the type results in warnings/errors for anyone referencing NamedTuple in their docs, so maybe we need to be careful when changing such types.
First example that came to mind was the peps repo, with some hits for TypedDict: https://github.com/search?q=repo%3Apython%2Fpeps+%2F%3Aclass%3A%60%28%28%7E%29%3Ftyping%5C.%29%3FTypedDict%2F&type=code
There was a problem hiding this comment.
Not sure NamedTuple is likely to change, but I brought back the revert in 4244745.
It seems to me that status quo is a safer approach.
johnslavik
changed the title
TypedDict and NamedTuple in class role in docsTypedDict in class role in docs
This reverts commit c323af9.
johnslavik
changed the title
TypedDict in class role in docsTypedDict and NamedTuple in class role in docs
3 participants
Partially reverts GH-143692; see #143692 (comment)
📚 Documentation preview 📚: https://cpython-previews--143702.org.readthedocs.build/