feat(docs): type fix - apply pep8 by using docstring instead of comment in the doc.#135181
Merged
Conversation
Giving the right example incitates the tutorial readers to do the same in the future.
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
Bot
added
awaiting review
docs
jlguenego
changed the title
jlguenego
changed the title
StanFromIreland
approved these changes
Jun 5, 2025
StanFromIreland
left a comment
StanFromIreland
left a comment
Member
There was a problem hiding this comment.
Since this is the tutorial, I think it makes logical sense to present best practices.
vstinner
reviewed
Jun 6, 2025
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Victor Stinner <vstinner@python.org>
vstinner
added
needs backport to 3.13
|
Thanks @jlguenego for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
|
Thanks @jlguenego for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 6, 2025
…nt in the doc. (pythonGH-135181) Giving the right example incitates the tutorial readers to do the same in the future. (cherry picked from commit 3431828) Co-authored-by: Jean-Louis GUENEGO <jlguenego@gmail.com>
|
GH-135211 is a backport of this pull request to the 3.13 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 6, 2025
…nt in the doc. (pythonGH-135181) Giving the right example incitates the tutorial readers to do the same in the future. (cherry picked from commit 3431828) Co-authored-by: Jean-Louis GUENEGO <jlguenego@gmail.com>
|
GH-135212 is a backport of this pull request to the 3.14 branch. |
Member
|
Merged, thanks. |
vstinner
pushed a commit
that referenced
this pull request
Jun 6, 2025
…f comment in the doc. (GH-135181) (#135212) feat(docs): type fix - apply pep8 by using docstring instead of comment in the doc. (GH-135181) Giving the right example incitates the tutorial readers to do the same in the future. (cherry picked from commit 3431828) Co-authored-by: Jean-Louis GUENEGO <jlguenego@gmail.com>
vstinner
pushed a commit
that referenced
this pull request
Jun 6, 2025
…f comment in the doc. (GH-135181) (#135211) feat(docs): type fix - apply pep8 by using docstring instead of comment in the doc. (GH-135181) Giving the right example incitates the tutorial readers to do the same in the future. (cherry picked from commit 3431828) Co-authored-by: Jean-Louis GUENEGO <jlguenego@gmail.com>
Pranjal095
pushed a commit
to Pranjal095/cpython
that referenced
this pull request
Jul 12, 2025
…nt in the doc. (python#135181) Giving the right example incitates the tutorial readers to do the same in the future.
taegyunkim
pushed a commit
to taegyunkim/cpython
that referenced
this pull request
Aug 4, 2025
…nt in the doc. (python#135181) Giving the right example incitates the tutorial readers to do the same in the future.
Agent-Hellboy
pushed a commit
to Agent-Hellboy/cpython
that referenced
this pull request
Aug 19, 2025
…nt in the doc. (python#135181) Giving the right example incitates the tutorial readers to do the same in the future.
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
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.
replace comments by pep8 docstring for function definition.
📚 Documentation preview 📚: https://cpython-previews--135181.org.readthedocs.build/