Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gboeing authored Apr 23, 2024
1 parent 653f700 commit cf0d9d7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions modules/15-next-steps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Rule of three: if a piece of code appears three or more times, extract it into i

Notebooks are useful for interactive analytics and seeing results, but most "workhorse" code can be extracted into a reusable module.

Use a **code formatter**. Common Python formatters are [black](https://pypi.org/project/black/) and [isort](https://pycqa.github.io/isort/). A typical approach is to use these tools as git [commit hooks](https://githooks.com/).
Use a **code formatter**. Common Python formatters are [black](https://pypi.org/project/black/), [isort](https://pycqa.github.io/isort/), and [ruff](https://docs.astral.sh/ruff/). A typical approach is to use these tools as git [commit hooks](https://githooks.com/) with [pre-commit](https://pre-commit.com/).

**Lint** your code. Common Python linters include [flake8](https://flake8.pycqa.org/) for code quality and [pydocstyle](https://www.pydocstyle.org/) for docstrings (see below).
**Lint** your code. Common Python linters include [flake8](https://flake8.pycqa.org/) for code quality and [pydocstyle](https://www.pydocstyle.org/) for docstrings (see below). Nowadays, [ruff](https://docs.astral.sh/ruff/) is increasingly common.

**Unit tests** are automated tests of individual pieces of your code. They test your individual functionality for bugs as you change bits of the codebase around them. Consider pairing your unit tests with a test coverage tool like [codecov](https://codecov.io).

Expand Down

0 comments on commit cf0d9d7

Please sign in to comment.