Formatting code in docstrings #2367
Open
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.
What is the change? Why is it being made?
Here I institute a new
ruffrule so the example code in our docstrings matches the formatting and linting rules in the rest of the case base. It's not a hugely important change, but I feel it makes things cleaner.NOTE: This is a docstring-only change.
SCR Information
Change Type: docs
One-Sentence Rationale: The example Python code in our docs should follow the same formatting and linting rules as the rest of the codebase.
One-line Impact on Requirements: NA
Checklist
docfolder.pyproject.toml.