Document that pre-commit is used for linting

This commit is contained in:
Pradyun Gedam 2019-09-24 17:01:45 +05:30
parent 7b005c2d7d
commit 0a25c7d4a6
No known key found for this signature in database
GPG Key ID: DA17C4B29CB32E4B
1 changed files with 3 additions and 3 deletions

View File

@ -67,9 +67,9 @@ tools, you can tell pip to skip those tests:
Running Linters
---------------
pip uses :pypi:`flake8` and :pypi:`isort` for linting the codebase. These
ensure that the codebase is in compliance with :pep:`8` and the imports are
consistently ordered and styled.
pip uses :pypi:`pre-commit` for managing linting of the codebase.
``pre-commit`` performs various checks on all files in pip and uses tools that
help follow a consistent code style within the codebase.
To use linters locally, run: