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.

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

Update instructions to install latest version of black #973

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
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
6 changes: 5 additions & 1 deletion doc/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,18 @@ code needs re-formatting.
Black can be installed using pip.

```bash
pip install black
pip install git+git://github.com/psf/black
```

To format the code, you run `black` followed by the filename you wish to reformat. For formatting a particular file name filename.py.

```bash
black filename.py
```
You can run Black as a package if running it as a script doesn't work:
```bash
python -m black filename.py
```

In many cases, it will make your life easier if you only run black on
files you've changed because you won't have to scroll through a pile of
Expand Down
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ pyyaml
pytest
pytest-xdist
pytest-cov
pytest-asyncio
pytest-asyncio
git+git://github.com/psf/black