Skip to content

Commit ac3d85c

Browse files
committed
Add developer documentation
1 parent c0e93c1 commit ac3d85c

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/html/development/getting-started.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,23 @@ To use linters locally, run:
148148
readability problems.
149149

150150

151+
Type Checking
152+
=============
153+
154+
pip uses :pypi:`mypy` for static type checking to help catch type errors early.
155+
Type checking is configured to run across the entire codebase to ensure type safety.
156+
157+
To run type checking locally:
158+
159+
.. code-block:: console
160+
161+
$ nox -s typecheck
162+
163+
This will run mypy on the ``src/pip``, ``tests``, and ``tools`` directories,
164+
as well as ``noxfile.py``. Type checking helps maintain code quality by
165+
catching type-related issues before they make it into the codebase.
166+
167+
151168
Running pip under a debugger
152169
============================
153170

0 commit comments

Comments
 (0)