Repository navigation
Links to PEP 585 in Generic types #140121
Description
Activity
What's the substantive proposed change?
A
Going through and find and replacing everything that says "See PEP 585" with a link to more recent documentation on the subject. Coming from #128336 (comment)
- changed the title
[-]Links PEP 585 in Generic types[/-][+]Links to PEP 585 in Generic types[/+]on Oct 14, 2025 Personally not the biggest fan of a docstring just being a link, even if it's a link to something comprehensive. Might it make sense to start the docstring with a short sentence explaining that the method allows the class to be subscripted for use as a parameterized generic, or something along those lines? It doesn't have to be a detailed explanation, but at least it won't be nothing. Just a thought.
Reacted by Adam TurnerYes, we shouldn't put links in docstrings. Whilst 'See PEP 585' isn't self-documenting, it is a reference to an effectively immutable document/concept.
Note also that PEP 585 redirects the reader to the relevant d.p.o documentation.
If we change the docstrings here, it should be to something both brief and that doesn't rely on external references (though saying words to the effect of 'see PEP 585' is fine, we should just avoid hyperlinks).
A
Reacted by Thanos
Documentation
Currently a lot of places refer to PEP 585, this is not recommend as the PEP is not a living documentation and isn't updated any more.
Happy to do update this myself