document

Author: MarcoGorelli

.pre-commit-config.yaml

@@ -41,9 +41,11 @@ repos:
       entry: python scripts/check_toc_is_complete.py
       language: python
       name: Check all notebooks appear in table of contents
+      pass_filenames: false
       types: [jupyter]
     - id: check-no-tests-are-ignored
       entry: python scripts/check_all_tests_are_covered.py
       files: ^\.github/workflows/pytest\.yml$
       language: python
       name: Check no tests are ignored
+      pass_filenames: false

scripts/check_all_tests_are_covered.py

@@ -1,3 +1,12 @@
+"""
+In .github/workflows/pytest.yml, tests are split between multiple jobs.
+
+Here, we check that the jobs ignored by the first job actually end up getting
+run by the other jobs.
+This is intended to be used as a pre-commit hook, see `.pre-commit-config.yaml`.
+You can run it manually with `pre-commit run check-no-tests-are-ignored --all`.
+"""
+
 from pathlib import Path
 
 import re