-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
CLN: Format doc code blocks #36700
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
CLN: Format doc code blocks #36700
Conversation
This reverts commit 1903765.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @dsaxton is there a tool to do/check this?
I was using this one which seems quite good https://github.com/asottile/blacken-docs |
cool. is there lots to do? is this good first issue material? |
I think this covers all or most of it (but of course doesn't handle updates to the docs) |
Thanks @dsaxton |
@@ -33,6 +33,7 @@ exclude = | |||
env # exclude asv benchmark environments from linting | |||
|
|||
[flake8-rst] | |||
max-line-length = 88 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As mentioned on the other PR as well, I think this is too much, because that doesn't fit on the rendered html doc page. Based on one example I looked at in the other PR, something like 84 might be better.
Trying to make code blocks in documentation black compliant. Also a small update to the flake8-rst config making max-line-length equal to 88.