From: Daniele Varrazzo Date: Wed, 30 Apr 2025 13:03:47 +0000 (+0200) Subject: docs: add link to pre-commit project in readme. X-Git-Tag: 3.3.0.dev1~79 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=06873a51ca4c8edf7182d9e4b5acff8adb4b1ffa;p=thirdparty%2Fpsycopg.git docs: add link to pre-commit project in readme. Also reflow a paragraph because it seems that the `-e` at the beginning of the line introduces a line break in the Github rendering of the readme. --- diff --git a/README.rst b/README.rst index 575e1731e..2abb328ca 100644 --- a/README.rst +++ b/README.rst @@ -72,8 +72,8 @@ requirements:: .. __: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs -Please add ``--config-settings editable_mode=strict`` to the ``pip install --e`` above if you experience `editable mode broken`__. +Please add ``--config-settings editable_mode=strict`` to the ``pip install -e`` +above if you experience `editable mode broken`__. .. __: https://github.com/pypa/setuptools/issues/3557 @@ -83,7 +83,7 @@ Now hack away! You can run the tests using:: export PSYCOPG_TEST_DSN="dbname=psycopg_test" pytest -The library includes some pre-commit hooks to check that the code is valid +The project includes some `pre-commit`__ hooks to check that the code is valid according to the project coding convention. Please make sure to install them by running:: @@ -92,6 +92,8 @@ by running:: This will allow to check lint errors before submitting merge requests, which will save you time and frustrations. +.. __: https://pre-commit.com/ + Cross-compiling ---------------