-
-
Notifications
You must be signed in to change notification settings - Fork 6.9k
blacken-docs #8906
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
blacken-docs #8906
Conversation
@@ -213,14 +214,14 @@ Note that the `basename` is provided by the router during `ViewSet` registration | |||
|
|||
Using the example from the previous section: | |||
|
|||
```python | |||
>>> view.reverse_action('set-password', args=['1']) | |||
```pycon |
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.
Is pycon a valid syntax highlighter?
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.
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.
I wasn't aware of this. Thanks :D
docs/api-guide/caching.md
Outdated
content = { | ||
'user_feed': request.user.get_user_feed() | ||
} |
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.
maybe we can do
content = {
'user_feed': request.user.get_user_feed(),
}
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.
This is something changed by the command, not a manual change.
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.
Please add a comma at the end to make it look identical to old version
docs/api-guide/caching.md
Outdated
content = { | ||
'user_feed': request.user.get_user_feed() | ||
} |
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.
content = {
'user_feed': request.user.get_user_feed(),
}
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.
This is something changed by the command, not a manual change.
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.
Please add a comma at the end to make it look identical to old version
docs/api-guide/caching.md
Outdated
content = { | ||
'title': 'Post title', | ||
'body': 'Post content' | ||
} |
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.
content = {
'title': 'Post title',
'body': 'Post content',
}
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.
This is something changed by the command, not a manual change.
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.
Please add commas at the end to make it look identical to old version
@baseplate-admin Thank you for the initial review. Please notice the structure of the commits -- third commit changes are by the command itself -- i.e. I didn't make those changes. So what's for review is really the remaining changes (please note the commit message). |
Yep i am aware that it was automatically changed by black. But i am asking to add a comma at the end to make the block look how it used to look. |
@baseplate-admin OK I understand, thank you for the feedback, will change and re-run locally before pushing anything -- will try to get to it asap. Thanks! |
…es other than "docs" to be compatible with "--all-files" flag.
@baseplate-admin Changes you suggested work, thanks 👍 |
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.
Just one small edit and everything else looks good :D
docs/api-guide/caching.md
Outdated
@method_decorator( | ||
vary_on_headers( | ||
"Authorization", | ||
) | ||
) |
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.
I think this looks better, dont you think so?
@method_decorator(vary_on_headers("Authorization"))
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.
@baseplate-admin Absolutely, I didn't want this PR to touch any of this though, that's why I only applied changes that I had to. But will push this, it's a very minor change. Thanks!
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.
@baseplate-admin Pushed (squashed change into previous commit).
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.
LGTM....
Thanks a bunch @jvzammit
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
@baseplate-admin Thank you for approving. Can this be merged? |
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.
Valid. 🖤
blacken-docs
Description
This PR shows the changes made by applying blacken-docs to the project's
docs
.It's objective is to show:
The second commit adds
blacken-docs
step to the precommit hook config file.This breaks on CI right now. And I couldn't replicate the issue locally. Help very much appreciated.Update: Fixed in
fourth andfifth commit.