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

Updates readme.md #53

Closed
wants to merge 1 commit into from
Closed
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
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