Skip to content

Run black on all files #1325

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
wants to merge 5 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/tutorials/contributing/guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@ The project follows the following guidelines:
<https://www.python.org/dev/peps/pep-0008/>`_ which includes **using
descriptive variable names**.
3. Code Format: Use the `Black formatter <https://github.com/ambv/black>`_ to format
all code and the `isort utility <https://github.com/timothycrosley/isort>`_ to
sort import statements.
all code and the `isort utility <https://github.com/timothycrosley/isort>`_ to
sort import statements. You can run black on all code with::

$ python -m black -l 80 .
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this TJ 👍


4. Commits: Please try to use commit messages that give a meaningful history
for anyone using git's log features. Try to use messages that complete sentence,
"This commit will..." There is some excellent guidance on the subject
Expand Down