René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"List generic arguments for `collections.abc` base classes in documentation","articleBody":"# Documentation\r\n\r\nWhen #123544 lands, we'll have PEP585-related documentation spread even further than before. Deprecated aliases in `typing` correctly list the generic arguments, but are otherwise undocumented - all such entries boil down to \"deprecated in favour of `collections.abc.X`\". \r\n\r\nSeveral relevant changes were discussed along #123523.\r\n\r\nThere's no direct way for a user to find generic parameters of `collections.abc.Generator` - they are listed for `typing.Generator` and in \"annotating generators and coroutines\" section in `typing` docs (the latter linked from `collections.abc.Generator`, though). \r\n\r\nI'm certain that generic arguments represent an essential part of class' \"signature\" - basic amount of information we need to see to use it somehow. \r\n\r\nHowever, `collections.abc` is not really a type-hinting module, hence providing those signatures there directly can add too much cognitive load.\r\n\r\nAs of now, my best suggestion is to introduce \"Type parameters\" section for each generic alias there, like this:\r\n\r\n```rst\r\n.. class:: Mapping\r\n           MutableMapping\r\n\r\n   ABCs for read-only and mutable :term:`mappings \u003cmapping\u003e`.\r\n\r\n   Type arguments:\r\n\r\n   * ``Mapping[KT, VT_co](Collection[KT])``\r\n   * ``MutableMapping[KT, VT](Mapping[KT, VT])``\r\n```\r\n\r\ncc @AA-Turner and @AlexWaygood - we started this discussion in the PR above.","author":{"url":"https://github.com/sterliakov","@type":"Person","name":"sterliakov"},"datePublished":"2024-09-01T20:23:54.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/123583/cpython/issues/123583"}