-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Docstring formatting: Preserve tab indentation when using indent-style=tabs
#9915
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
|
MichaReiser
force-pushed
the
preserve-docstring-tabs
branch
from
February 9, 2024 20:42
25071ca
to
6d2417a
Compare
MichaReiser
force-pushed
the
preserve-docstring-tabs
branch
from
February 9, 2024 20:51
6d2417a
to
83b40d6
Compare
MichaReiser
force-pushed
the
preserve-docstring-tabs
branch
from
February 10, 2024 06:39
3ad02d3
to
974e485
Compare
BurntSushi
approved these changes
Feb 12, 2024
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.
This looks great to me! I think it might help to polish up the Indent
type a touch, but I love the approach. :)
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.
Summary
This PR ensures that the formatter preserves
tab
s inside of docstring when usingindent-style=tab
.Today, the formatter converts all docstring-indent to spaces, regardless of the configured indent-style.
This is unexpected for users and creates with
E101
(mixed-spaces-and-tabs
). For example:Gets reformatted to
Even though the user expliclty wants tab indentations.
The formatter won't automatically convert multiples of
indent-width
spaces to tabs because it can breakASCII arts (and other formatting that use spaces for alignmen).
The downside of this change is tha the formatter won't enforce a consistent indentation inside of docstrings when using
indent-style=tab
.Fixes #8430
This PR does not yet address that our formatter always expands
tab
to 8 spaces (instead of the configuredindent-width
)It's not necessary to gate this change behind preview because it doesn't change already formatted code.
Test Plan
added tests,
cargo test