From 7339a868645c1a2b16501dc38028f85967d75250 Mon Sep 17 00:00:00 2001 From: Eva Lott Date: Mon, 6 Feb 2023 09:26:29 +0000 Subject: [PATCH] Added references to pre-commit installation --- docs/developer/how-to/lint.rst | 3 +++ docs/user/how-to/existing.rst | 4 ++++ docs/user/tutorials/new.rst | 5 +++++ 3 files changed, 12 insertions(+) diff --git a/docs/developer/how-to/lint.rst b/docs/developer/how-to/lint.rst index 1086c3c4..8f4e92db 100644 --- a/docs/developer/how-to/lint.rst +++ b/docs/developer/how-to/lint.rst @@ -15,6 +15,9 @@ commit`` on just the files that have changed:: $ pre-commit install +It is also possible to `automatically enable pre-commit on cloned repositories `_. +This will result in pre-commits being enabled on every repo your user clones from now on. + Fixing issues ------------- diff --git a/docs/user/how-to/existing.rst b/docs/user/how-to/existing.rst index e85d14c8..cd3d49b7 100644 --- a/docs/user/how-to/existing.rst +++ b/docs/user/how-to/existing.rst @@ -20,6 +20,10 @@ This will: To enable publishing to PyPI see `../how-to/pypi` +.. note:: + + To install the pre-commit see `../../developer/how-to/lint` + Example merge ------------- diff --git a/docs/user/tutorials/new.rst b/docs/user/tutorials/new.rst index 91bade31..195b10d3 100644 --- a/docs/user/tutorials/new.rst +++ b/docs/user/tutorials/new.rst @@ -49,6 +49,11 @@ project or github Organization. see `../how-to/pypi` +Setting up pre-commit +--------------------- + +To install the pre-commit see `../../developer/how-to/lint`. + Running the tests -----------------