FIX: Add pre-commit Blacken-docs hooks #54137
Closed
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.
doc/source/whatsnew/vX.X.X.rst
file if fixing a bug or adding a new feature.This PR adds the configuration for the
blacken-docs
hook to the project's.pre-commit-config.yaml
file. Theblacken-docs
hook applies the Black code formatter to reStructuredText (reST) files.To accommodate potential parsing errors encountered with certain code blocks, the
--skip-errors
argument is included in the hook configuration. This argument instructsblacken-docs
to skip errors and continue processing other files and blocks.By including the
blacken-docs
hook with error skipping, we can ensure consistent formatting of reST files while allowing exceptions for code blocks that may contain unsupported syntax.Please review this PR and provide any feedback or suggestions for improvement.
@noatamir @phofl SciPy Sprint 2023