gh-105812: Make use of the Sphinx deco role in documentation, part 1
#139598
Conversation
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
… part 1 For the following decorators: `classmethod`, `staticmethod`, `property`, ABC decorators, enum decorators, `functools.lru_cache`, `functools.cache`.
Viicos
requested review from
AA-Turner,
ethanfurman,
rhettinger and
willingc
as code owners
Member
|
If this is 'part 1', what are the expected follow-up changes? A |
Contributor
Author
I'll comment on the original issue the remaining ones. Let me know if this is fine to tackle everything in a single PR. |
Member
I'd prefer one PR to review, as long as the diff stays reasonable. A |
Contributor
Author
|
@AA-Turner I migrated the remaining decorators. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
For the following decorators:
classmethod,staticmethod,property, ABC decorators, enum decorators,functools.lru_cache,functools.cache.Note that depending on the context, I left references as
:func:or:class:, for instance when it is reference as "the <...> object/function/descriptor".📚 Documentation preview 📚: https://cpython-previews--139598.org.readthedocs.build/