Use ruff's docstring formatting #7276
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
MridulS
approved these changes
Feb 8, 2024
jarrodmillman
approved these changes
Feb 9, 2024
rossbar
reviewed
Feb 9, 2024
There was a problem hiding this comment.
Aside from removing blacken-docs, was there also a change in the config to add ruff's docstring formatter? I don't see any changes to pyproject.toml (perhaps I just missed it when skimming the diff!)
Nevermind, just saw it allll the way down at the end of the diff 👍
rossbar
approved these changes
Feb 9, 2024
cvanelteren
pushed a commit
to cvanelteren/networkx
that referenced
this pull request
Apr 22, 2024
Switch from blacken-docs to ruff-format for 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.
This PR replaces blacken-docs with ruff's docstring formatting.
As mentioned in #7270, I noticed that there were some docstrings that looked like they weren't already formatted. So the diff is pretty large.
Also we might want to tweak the configuration here depending on your preference, assuming this is a change you'd like to make.
Let me know if you'd like to tie this to an issue. I'd be happy to open one for this.