]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: add link to pre-commit project in readme.
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Wed, 30 Apr 2025 13:03:47 +0000 (15:03 +0200)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Wed, 30 Apr 2025 13:03:47 +0000 (15:03 +0200)
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.

README.rst

index 575e1731e257b9d937761db97316e41742ad0b78..2abb328ca92b40d087c875912d3f94c55acdb92d 100644 (file)
@@ -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
 ---------------