Doc: mark up classes, attributes, parameters, and methods in dataclasses.rst #117820
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
erlend-aasland
added
skip issue
skip news
needs backport to 3.12
ericvsmith
reviewed
Apr 12, 2024
Member
ericvsmith
left a comment
ericvsmith
left a comment
There was a problem hiding this comment.
I don't know enough about sphinx to do a decent review here, but I don't see anything obviously wrong.
hugovk
reviewed
Apr 13, 2024
hugovk
approved these changes
Apr 14, 2024
Member
hugovk
left a comment
hugovk
left a comment
There was a problem hiding this comment.
Looks good 👍
Another little improvement that could be in this or another PR, in the first paragraph:
-adding generated :term:`special method`\s such as :meth:`~object.__init__` and
+adding generated :term:`special methods <special method>` such as :meth:`~object.__init__` and"generated special methods" -> "generated special methods"
(We already have it like this further down the page.)
Contributor
Author
|
Thanks for the reviews! |
AlexWaygood
reviewed
Apr 14, 2024
Contributor
Author
|
Thanks for chiming in Alex 🙏 I think we can land this now. |
AlexWaygood
reviewed
Apr 14, 2024
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
erlend-aasland
added
needs backport to 3.12
This comment was marked as outdated.
This comment was marked as outdated.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Apr 14, 2024
…ses.rst (pythonGH-117820) (cherry picked from commit e018317) Co-authored-by: Erlend E. Aasland <erlend@python.org>
|
GH-117877 is a backport of this pull request to the 3.12 branch. |
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this pull request
Apr 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
📚 Documentation preview 📚: https://cpython-previews--117820.org.readthedocs.build/en/117820/library/dataclasses.html