You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -49,6 +49,8 @@ Install development dependencies with (you might want to create a virtualenv fir
49
49
50
50
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.
51
51
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
+
52
54
This project uses `pre-commit`_ to enforce code-quality. After cloning the repository install the pre-commit hooks with:
53
55
54
56
::
@@ -59,5 +61,6 @@ After that pre-commit will run `all defined hooks`_ on every ``git commit`` and
0 commit comments