enhancement #37: update pre-commit. add mistake to check CI

Author: FabienDanieau

.github/workflows/docs.yml

@@ -16,7 +16,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install .[dev]
-      - name : Check import order
+      - name : Check docstrings
         run : pydocstyle src/ --convention google --count
 
   build-docs:

scripts/git_hooks/pre-commit

@@ -24,3 +24,6 @@ echo "-------> Flake8 passed!"
 mypy .
 echo "-------> Mypy passed!"
 
+# Run pydocstring against all code in the `source_code` directory
+pydocstyle --convention google src/
+echo "-------> pydocstring passed!"

src/main.py

@@ -1,4 +1,4 @@
-"""Main script for the application.
+"""Main script for the application
 
 This script processes command-line arguments, performs various operations using classes and
 methods from the `example` module, and uses data stored in configuration files. It logs