clarified that mypy ignores new functions

story645 · story645 · commit e556fe1ca37f · 2024-06-14T16:26:46.000-04:00
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -89,8 +89,11 @@ We generally use `stub files
 the type information for ``colors.py``. A notable exception is ``pyplot.py``,
 which is type hinted inline.
 
-Type hints are checked by the mypy :ref:`pre-commit hook <pre-commit-hooks>`,
-can often be verified by running ``tox -e stubtest``.
+Type hints can be validated by the ``stubtest`` tool, which can be run
+locally using ``tox -e stubtest`` and is a part of the :ref:`automated-tests`
+suite. Type hints for existing functions are also checked by the mypy
+:ref:`pre-commit hook <pre-commit-hooks>`.
+
 
 New modules and files: installation
 ===================================
diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst
@@ -254,3 +254,9 @@ listed in ``.pre-commit-config.yaml``, against the full codebase with ::
 To run a particular hook manually, run ``pre-commit run`` with the hook id ::
 
     pre-commit run <hook id> --all-files
+
+
+Please note that the ``mypy`` pre-commit hook cannot check the :ref:`type-hints`
+for new functions; instead the stubs for new functions are checked using the
+``stubtest`` :ref:`CI check <automated-tests>` and can be checked locally using
+``tox -e stubtest``.
