Disable top-level docstring formatting for notebooks #9957
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
added
formatter
dhruvmanila
reviewed
Feb 12, 2024
dhruvmanila
reviewed
Feb 12, 2024
crates/ruff_python_formatter/resources/test/fixtures/ruff/notebook_docstring.py
Show resolved
Hide resolved
dhruvmanila
approved these changes
Feb 12, 2024
|
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 handles strings at the top of a cell as non-docstrings. Handling them as docstrings has the undesired result that one might have multiple "docstrings" in a single notebook,
which is probably not what you want.
We don't need to gate this behind preview because it doesn't change any formatted code.
Test Plan
Added tests