-
-
Notifications
You must be signed in to change notification settings - Fork 30.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gh-106318: Add examples to str method entries #105670
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this! Mostly looks good, left a few minor comments
Most non-trivial contributions to CPython have an associated issue that serves as a place for higher level feedback and to track backports. I went ahead and opened one for this change in #106318
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with hauntsaninja's comments. Comment changes are required.
I also think most (all?) of the 'For example's could be moved to the end of the previous paragraph, or deleted and only the '::' put at the end of the previous paragraph instead of '.'
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Co-authored-by: Shantanu <[email protected]>
I have made the requested changes; please review again |
Thanks for making the requested changes! @terryjreedy: please review the changes made to this pull request. |
This PR improvements the str method documentation, adding snippet code in the follows methods and other minor improvements:
📚 Documentation preview 📚: https://cpython-previews--105670.org.readthedocs.build/