Skip to content

Commit

Permalink
add lines about black
Browse files Browse the repository at this point in the history
  • Loading branch information
purva-thakre committed Jun 13, 2021
1 parent 3d5d6b7 commit 141358c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,14 @@ pip install -e .
```
which makes sure that you are up to date with the latest `pip` version.

In order to check if your code in `some_file.py` follows `PEP8` style guidelines, [*Black*](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) has to be installed.
```
pip install black
python -m black some_file.py --diff --color
python -m black some_file.py
```
Using [*`--diff`*](https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#diffs) will show the changes that will be made by `Black`. If you would prefer these changes to be made, use the last line of above code block.

To build and test the documentation, additional packages need to be installed:

```
Expand Down

0 comments on commit 141358c

Please sign in to comment.