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.

Sign up for GitHub

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

Jump to bottom

docs: update black docs and sha #2117

Merged
merged 1 commit into from
Mar 6, 2021
Merged

docs: update black docs and sha #2117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/.git-blame-ignore-revs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
eaf8618c50c6bcd6db5f53740b23ffa4e525e556
640daf4d389768be216dac4125ef4e837ee65d23
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ It's easy to configure it:
1. `pip install pre-commit`
1. `pre-commit install`

Now you will be automatically reminded to add docstrings to your code. `black` will take care that your code will match our style.
Now you will be automatically reminded to add docstrings to your code. `black` will take care that your code will match our style. Note that `black` will fail your commit but reformat your code, so you just need to add the files again and commit **again**.

For more about our docstring style, refer to [this guide](https://docs.jina.ai/chapters/docstring/docstring.html).

Expand Down