Skip to content

Add blacken-docs to pre-commit #98

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

Closed
jorgepiloto opened this issue May 23, 2022 · 3 comments · Fixed by #228
Closed

Add blacken-docs to pre-commit #98

jorgepiloto opened this issue May 23, 2022 · 3 comments · Fixed by #228
Assignees
Labels
enhancement New features or code improvements

Comments

@jorgepiloto
Copy link
Member

Description of the feature

Something I discovered while working on #64 was that some of the code snippets were not compliant with the code style guidelines.

After looking for a solution, I came across blacken-docs, which turned out to be extremely useful.

Steps for implementing the feature

The main idea behind this new feature would be to add this doc style checker to our current style tests via pre-commit.

Useful links and references

Blacken-docs: https://github.com/asottile/blacken-docs/

@jorgepiloto jorgepiloto added the enhancement New features or code improvements label May 23, 2022
@jorgepiloto
Copy link
Member Author

⚠️ Notice some of our examples are non-style compliant on purpose

This is done to educate others on what to do and avoid. As long as blacken-docs can ignore these files, we can implement this feature.

@MaxJPRey
Copy link
Contributor

MaxJPRey commented Jul 17, 2022

@jorgepiloto I will implement it for PyAEDT. It should be even easier, because in this repo we shouldn't ignore any code samples.

@RobPasMue
Copy link
Member

Working on this. I will also implement pre-commit.ci in this task if it's okay with you all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants