From 5bf66265e8f5b9cc9d2b9435aec2d18f459028e5 Mon Sep 17 00:00:00 2001 From: Hans Fangohr <hans.fangohr@mpsd.mpg.de> Date: Wed, 21 Jun 2023 15:00:41 +0000 Subject: [PATCH] Apply changes from Hanss changes --- development.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/development.rst b/development.rst index 59ae675..71e325b 100644 --- a/development.rst +++ b/development.rst @@ -4,15 +4,15 @@ This section is for developers wanting to contribute to the project. Setup pre-commit hooks ---------------------- -The project uses [pre-commit](https://pre-commit.com/) to run some checks before committing code. -Install pre-commit by running the following command: +The project uses `pre-commit <https://pre-commit.com/>`__ to run some checks before committing code. +Install pre-commit by running the following command:: pip install pre-commit -To setup the pre-commit hooks, run the following command from the root of the project: +To setup the pre-commit hooks, run the following command from the root of the project:: pre-commit install Then every time you commit, pre-commit will run all checks defined in `.pre-commit-config.yaml`. -you can run the pre-commit checks manually by running: +you can run the pre-commit checks manually by running:: pre-commit run --all-files -- GitLab