gh-81283: compiler: remove indent from docstring #106411
Merged
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
|
methane
commented
Jul 4, 2023
| lines = doc.expandtabs().split('\n') | ||
| except UnicodeError: | ||
| return None | ||
| else: |
There was a problem hiding this comment.
I removed this try-except-else block because Python 3 don't autodecode from bytes.
If doc is bytes, doc.split('\n') raises TypeError, not UnicodeError.
methane
commented
Jul 4, 2023
| @@ -1287,14 +1287,14 @@ def optionflags(): r""" | |||
| treated as equal: | |||
|
|
|||
| >>> def f(x): | |||
| ... '>>> print(1, 2, 3)\n 1 2\n 3' | |||
| ... '\n>>> print(1, 2, 3)\n 1 2\n 3' | |||
There was a problem hiding this comment.
This change is needed to avoid dedenting output examples.
iritkatriel
reviewed
Jul 5, 2023
|
|
||
| Py_DECREF(doc); | ||
| return PyUnicode_FromStringAndSize(buff, w - buff); | ||
| } |
There was a problem hiding this comment.
I'm not sure the dedent logic belongs in compile.c.
There was a problem hiding this comment.
Because this dedent logic is very specific for docstring.
We can not use this logic in other place except inspect.cleandoc.
If we reuse this logic in inspect.cleandoc, it would be:
doc = compiler.cleandoc(doc).strip('\n')
methane
commented
Jul 5, 2023
| # Find minimum indentation of any non-blank lines after first line. | ||
| margin = sys.maxsize | ||
| for line in lines[1:]: | ||
| content = len(line.lstrip(' ')) |
There was a problem hiding this comment.
I changed from line.lstrip() to line.lstrip(' ') for better compatibility between inspect.cleandoc and compiler.cleandoc.
merwok
reviewed
Jul 14, 2023
Co-authored-by: Éric <merwok@netwok.org>
sunmy2019
reviewed
Jul 18, 2023
|
With the forum discussion ongoing, and the other discussion about requiring reviews, I think this could have waited a little bit to get a review approval. On the other hand it’s not a huge change! |
Carreau
added a commit
to Carreau/ipython
that referenced
this pull request
Dec 31, 2023
Since python/cpython#106411, it look like cpython is removing leading space and indent. We therefore need conditional check, until we decide Wether this is a problem we want to deal with or not.
Carreau
added a commit
to Carreau/ipython
that referenced
this pull request
Dec 31, 2023
Since python/cpython#106411, it look like cpython is removing leading space and indent. We therefore need conditional check, until we decide Wether this is a problem we want to deal with or not.
Carreau
added a commit
to ipython/ipython
that referenced
this pull request
Dec 31, 2023
Since python/cpython#106411, it look like cpython is removing leading space and indent. We therefore need conditional check, until we decide Wether this is a problem we want to deal with or not.
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.
📚 Documentation preview 📚: https://cpython-previews--106411.org.readthedocs.build/