Clarify imprecise reference to example #144219
Open
+1
−1
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
Modified one line of descriptive text. The text refers to "our example," despite there being five other examples in between the reference and the actual example to which the reference is intended. I added the word "previous" and parentheses with the text "first example on Class Objects," where "Class Objects" is a link to that section.
|
All commit authors signed the Contributor License Agreement. |
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
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.
Summary of the changes made
Modified one line of descriptive text.
The text refers to "our example," despite there being five other examples in between the reference and the actual example to which the reference is intended. Because of this, the reader may not understand what example is being referenced.
I added the word "previous" and parentheses with the text "first example on Class Objects," where "Class Objects" is a formatted link to that section.
Related issues and pull requests
There are no related issues or pull requests to this single line fix, as far as I know.
📚 Documentation preview 📚: https://cpython-previews--144219.org.readthedocs.build/