Skip to content

gh-89554: Document typing.ParamSpecArgs and ParamSpecKwargs as classes#150677

Open
gaborbernat wants to merge 1 commit into
python:mainfrom
gaborbernat:gh-89554-typing-paramspec-class-roles
Open

gh-89554: Document typing.ParamSpecArgs and ParamSpecKwargs as classes#150677
gaborbernat wants to merge 1 commit into
python:mainfrom
gaborbernat:gh-89554-typing-paramspec-class-roles

Conversation

@gaborbernat
Copy link
Copy Markdown
Contributor

@gaborbernat gaborbernat commented May 31, 2026

typing.ParamSpecArgs and typing.ParamSpecKwargs are classes (the runtime types of the args and kwargs attributes of a ParamSpec), but the documentation marks them with the .. data:: directive. The existing :class: cross-references to them in Doc/library/typing.rst and Doc/whatsnew/3.10.rst therefore resolve against a missing py:class target.

Switch the stacked entry to .. class:: so the references resolve. Both names share a single entry, so both are covered.

Refs: gh-89554. Documentation-only change, so no Misc/NEWS entry (skip news).

…classes

ParamSpecArgs and ParamSpecKwargs are classes (the runtime types of the
args and kwargs attributes of a ParamSpec), but were documented with the
".. data::" directive. The existing ":class:`ParamSpecArgs`" and
":class:`ParamSpecKwargs`" cross-references in the typing docs and the 3.10
What's New page therefore fail to resolve against a py:class target.

Switch the stacked entry to ".. class::" so the references resolve.
@read-the-docs-community
Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #32924402 | 📁 Comparing cc59bf0 against main (2f8f569)

  🔍 Preview build  

1 file changed
± library/typing.html

@JelleZijlstra JelleZijlstra added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels May 31, 2026
@gaborbernat
Copy link
Copy Markdown
Contributor Author

gaborbernat commented Jun 1, 2026

Backward-compatibility check. The only downstream :data: reference found is typing_extensions (doc/index.rst), which is maintained alongside CPython. :class: references to ParamSpecArgs already exist in typing.rst and whatsnew/3.10.rst. Low risk.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting merge docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants