gh-89554: Document weakref type objects as classes#150678
Open
gaborbernat wants to merge 1 commit into
Open
Conversation
ReferenceType, ProxyType and CallableProxyType are classes (the type objects for weak references and proxies), but were documented with the ".. data::" directive, so ":class:" cross-references to them cannot resolve against a py:class target. Switch these three entries to ".. class::". ProxyTypes is left as ".. data::" since it is a sequence of the proxy type objects, not a type itself.
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.
weakref.ReferenceType,weakref.ProxyType, andweakref.CallableProxyTypeare classes (the type objects for weak references and proxies), but the documentation marks them with the.. data::directive, so:class:cross-references to them cannot resolve against a py:class target.Switch these three entries to
.. class::.weakref.ProxyTypesis left as.. data::since it is a sequence of the proxy type objects, not a type itself.Refs: gh-89554. Documentation-only change, so no
Misc/NEWSentry (skip news).