Skip to content

Commit 6c44c3b

Browse files
committed
fix readme
1 parent 1b87138 commit 6c44c3b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Install development dependencies with (you might want to create a virtualenv fir
4949

5050
The project is formatted with `black`_. You can either configure your IDE to automatically format code with it, run it manually (``black .``) or rely on pre-commit (see below) to format files on git commit.
5151

52+
The project uses two rst tests in order to assure uploadability to pipy: `rst-linter`_ as a pre-commit hook and `rstcheck`_ in a GitHub workflow. This does not catch all errors.
53+
5254
This project uses `pre-commit`_ to enforce code-quality. After cloning the repository install the pre-commit hooks with:
5355

5456
::
@@ -59,5 +61,6 @@ After that pre-commit will run `all defined hooks`_ on every ``git commit`` and
5961

6062
.. _black: https://github.com/psf/black
6163
.. _rst-linter: https://github.com/Lucas-C/pre-commit-hooks-markup
64+
.. _rstcheck: https://github.com/myint/rstcheck
6265
.. _pre-commit: https://pre-commit.com/
6366
.. _all defined hooks: .pre-commit-config.yaml

0 commit comments

Comments
 (0)