gh-89554: Document typing.ParamSpecArgs and ParamSpecKwargs as classes#150677
Open
gaborbernat wants to merge 1 commit into
Open
gh-89554: Document typing.ParamSpecArgs and ParamSpecKwargs as classes#150677gaborbernat wants to merge 1 commit into
gaborbernat wants to merge 1 commit into
Conversation
…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.
Documentation build overview
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
typing.ParamSpecArgsandtyping.ParamSpecKwargsare classes (the runtime types of theargsandkwargsattributes of aParamSpec), but the documentation marks them with the.. data::directive. The existing:class:cross-references to them inDoc/library/typing.rstandDoc/whatsnew/3.10.rsttherefore 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/NEWSentry (skip news).