Skip to content

Commit 17ec3ca

Browse files
authored
Mention how to test third party stubs (#13505)
Fixes #12241
1 parent 448e657 commit 17ec3ca

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

docs/source/command_line.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,8 @@ in developing or debugging mypy internals.
830830
submitting them upstream, but also allows you to use a forked version of
831831
typeshed.
832832

833-
Note that this doesn't affect third-party library stubs.
833+
Note that this doesn't affect third-party library stubs. To test third-party stubs,
834+
for example try ``MYPYPATH=stubs/six mypy ...``.
834835

835836
.. _warn-incomplete-stub:
836837

docs/source/config_file.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -858,9 +858,16 @@ These options may only be set in the global section (``[mypy]``).
858858

859859
:type: string
860860

861-
Specifies an alternative directory to look for stubs instead of the
862-
default ``typeshed`` directory. User home directory and environment
863-
variables will be expanded.
861+
This specifies the directory where mypy looks for standard library typeshed
862+
stubs, instead of the typeshed that ships with mypy. This is
863+
primarily intended to make it easier to test typeshed changes before
864+
submitting them upstream, but also allows you to use a forked version of
865+
typeshed.
866+
867+
User home directory and environment variables will be expanded.
868+
869+
Note that this doesn't affect third-party library stubs. To test third-party stubs,
870+
for example try ``MYPYPATH=stubs/six mypy ...``.
864871

865872
.. confval:: warn_incomplete_stub
866873

0 commit comments

Comments
 (0)