STY: Bump ruff; use ruff's docstring/code formatting #56554
Closed
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
mroeschke
requested review from
attack68,
rhshadrach,
MarcoGorelli,
WillAyd and
noatamir
as code owners
twoertwein
reviewed
Dec 19, 2023
2 tasks
Comment on lines
-66
to
-67
| MSG='Partially validate docstrings (EX03)' ; echo $MSG | ||
| $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX03 --ignore_functions \ |
There was a problem hiding this comment.
are you sure we can remove this? this checks for flake8 errors within docstrings, but it depends on the docstrings having been built in the first place using the fancy @doc decorator, which ruff format doesn't check
twoertwein
reviewed
Dec 29, 2023
| @@ -368,6 +349,10 @@ exclude = [ | |||
| # Keep this one enabled | |||
| "pandas/_typing.py" = ["TCH"] | |||
|
|
|||
| [tool.ruff.format] | |||
| docstring-code-format = true | |||
There was a problem hiding this comment.
Personally, I like to replace as much with ruff as possible :) but it might be faster to have one PR to replace black and a second one for the doc formatting (I believe black isn't used for that?).
There was a problem hiding this comment.
Good point. Opened up #56704 to just replace black
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.
Looks like ruff now has the ability to replace black and format docstring examples too.
Appears there are some formatting differences but they appear minor IMO and at least the format requires no manual adjusting