Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A --check mode would be useful #161

Closed
simonw opened this issue Apr 24, 2022 · 3 comments
Closed

A --check mode would be useful #161

simonw opened this issue Apr 24, 2022 · 3 comments

Comments

@simonw
Copy link
Contributor

simonw commented Apr 24, 2022

I like to run tests in CI against pull requests that fail if the user forgot to run Black or various other tools.

Black provides a useful --check option for this:

black --check .

It would be great if blacken-docs had the equivalent.

@asottile
Copy link
Contributor

please search the issue tracker

@simonw
Copy link
Contributor Author

simonw commented Apr 24, 2022

@simonw
Copy link
Contributor Author

simonw commented Apr 24, 2022

Thanks - I figured out how to solve my problem from those comments. Wrote it up here: https://til.simonwillison.net/sphinx/blacken-docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants