Skip to content

Commit 9d502c9

Browse files
committed
Update hooks doc
1 parent 6ae40e5 commit 9d502c9

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/developer/GIT-HOOKS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ Pre-commit Hook
1212

1313
The pre-commit hook script will:
1414
1. Check for trailing white spaces in files
15-
2. Run ruff to verify python code formatting valid
15+
2. Run ruff to verify python code formatting is valid
1616
3. Run codespell to check the spelling
1717
4. Run sphinx-build to rebuild the documentation into `FastSurfer/doc-build`
18-
Here, one important caveat for documentation editors is the that sphinx-build may fail if the documentation file
19-
structure is changed, but the autosummary/autodoc-generated files are not cleaned. To do this, delete the following
18+
Here, one important caveat for documentation editors is that sphinx-build may fail if the documentation file
19+
structure is changed, without first cleaning the autosummary/autodoc-generated files. To do this, delete the following
2020
directory `FastSurfer/doc/api/generated`.
2121

2222
### Installation

0 commit comments

Comments
 (0)