fix formatting of literal in docstring of int.from_bytes and int.to_bytes #117847
Conversation
This file contains 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
|
All commit authors signed the Contributor License Agreement. |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
80c1489 to
aa2fd3d
Compare
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
This seemed to be too trivial for a news entry but let me know if I am wrong |
aa2fd3d to
428d96f
Compare
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
In docstring of from_bytes and to_bytes. Use same char for start and end.
428d96f to
c5c9be3
Compare
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
JelleZijlstra
approved these changes
Apr 18, 2024
|
Thanks @jenshnielsen for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
|
Sorry, @jenshnielsen and @JelleZijlstra, I could not cleanly backport this to |
|
AFAIK this was intentional -- it's the traditional GNU quoting style. But yes, nowadays, it probably looks like a mistake to most people; even GNU projects tend to no longer recommend it. |
|
@encukou yes, I've seen it before too. I grepped through the codebase for other similar uses and there are a handful, including these that appear to be in docstrings: |
geofft
added a commit
to geofft/cpython
that referenced
this pull request
May 20, 2024
As reported in python#117847 and python#115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings, error messages, etc. I've left ./configure and friends alone because that isn't going to impact downstream tools and feels like a lot of churn.
geofft
added a commit
to geofft/cpython
that referenced
this pull request
May 20, 2024
As reported in python#117847 and python#115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings, error messages, etc. I've left ./configure and friends alone because that isn't going to impact downstream tools and feels like a lot of churn.
geofft
added a commit
to geofft/cpython
that referenced
this pull request
May 20, 2024
As reported in python#117847 and python#115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings, error messages, etc. I've left ./configure and friends alone because that isn't going to impact downstream tools and feels like a lot of churn.
geofft
added a commit
to geofft/cpython
that referenced
this pull request
May 20, 2024
As reported in python#117847 and python#115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings, error messages, etc. I've left ./configure and friends alone because that isn't going to impact downstream tools and feels like a lot of churn.
geofft
added a commit
to geofft/cpython
that referenced
this pull request
May 20, 2024
As reported in python#117847 and python#115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings.
geofft
added a commit
to geofft/cpython
that referenced
this pull request
May 21, 2024
As reported in python#117847 and python#115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings.
geofft
added a commit
to geofft/cpython
that referenced
this pull request
May 22, 2024
As reported in python#117847 and python#115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings.
carljm
pushed a commit
that referenced
this pull request
May 22, 2024
As reported in #117847 and #115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings.
estyxx
pushed a commit
to estyxx/cpython
that referenced
this pull request
Jul 17, 2024
As reported in python#117847 and python#115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The existing formatting causes a warning when building docs with sphinx that includes these docstrings. I ran into this issue when trying to build api docs of a subclass of enum.IntFlag with Sphinx configured to included docs from the super class. Here I am receiving errors like:
WARNING: Inline interpreted text or phrase reference start-string without end-string.I have not created an issue for this since it seems to fall under the trivial typo category. Let me know if that is wrong.