Adjust docs for tp_subclasses#31
Merged
ericsnowcurrently merged 1 commit intoericsnowcurrently:shareable-static-types-tp_subclassesfrom Aug 1, 2022
Conversation
- Member documentation describes the current state, for users. - The ``versionchanged`` note describes the change. - The What's New entry is, ideally, usable for someone stuck with maintaining a mysterious legacy codebase that stopped working. Details of internals are left out -- if it isn't enough to look at the source, they should be documented in the devguide rather than user-facing docs.
Owner
|
Thanks. This looks good. |
ericsnowcurrently
merged commit e7f580d
into
ericsnowcurrently:shareable-static-types-tp_subclasses
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
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.
(I started nitpicking as suggestions in python#95301, but wanted to build the docs to check the syntax.)
Here's how I'd write the docs:
versionchangednote describes the change.maintaining a mysterious legacy codebase that stopped working.
Details of internals are left out -- if it isn't enough to look
at the source, they should be documented in the devguide rather
than user-facing docs.