Add bin/lint utility

Add a utility per @fang19911030 request to apply `black` with the same settings that the GitHub action uses.
HopkinsIDD · Nov 1, 2024 · 71ee9b1 · 71ee9b1
1 parent 8e67ca8
commit 71ee9b1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/bin/lint b/bin/lint
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+black --line-length 92 \
+    --extend-exclude 'flepimop/gempyor_pkg/src/gempyor/steps_rk4.py' \
+    --verbose .
diff --git a/documentation/gitbook/development/python-guidelines-for-developers.md b/documentation/gitbook/development/python-guidelines-for-developers.md
@@ -73,7 +73,7 @@ black --line-length 92 \
     --verbose .
 ```
 
-For those using a Mac or Linux system for development you can take advantage of the formatting pre-commit hook found at `bin/pre-commit`. To start using it copy this file to your git hooks folder:
+For those using a Mac or Linux system for development this command is also available for use by calling `./dev/lint`. Similarly, you can take advantage of the formatting pre-commit hook found at `bin/pre-commit`. To start using it copy this file to your git hooks folder:
 
 ```bash
 cp -f bin/pre-commit .git/hooks/