From b92fbe15d3d376a6184690c3b38a21575db99720 Mon Sep 17 00:00:00 2001 From: hauntsaninja Date: Wed, 24 Aug 2022 20:16:31 -0700 Subject: [PATCH] Mention how to test third party stubs Fixes #12241 --- docs/source/command_line.rst | 3 ++- docs/source/config_file.rst | 13 ++++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/source/command_line.rst b/docs/source/command_line.rst index e2175a7f35d4d..41a27a6d1b546 100644 --- a/docs/source/command_line.rst +++ b/docs/source/command_line.rst @@ -830,7 +830,8 @@ in developing or debugging mypy internals. submitting them upstream, but also allows you to use a forked version of typeshed. - Note that this doesn't affect third-party library stubs. + Note that this doesn't affect third-party library stubs. To test third-party stubs, + for example try ``MYPYPATH=stubs/six mypy ...``. .. _warn-incomplete-stub: diff --git a/docs/source/config_file.rst b/docs/source/config_file.rst index 663a0d2229a63..ef6fcd2623d76 100644 --- a/docs/source/config_file.rst +++ b/docs/source/config_file.rst @@ -858,9 +858,16 @@ These options may only be set in the global section (``[mypy]``). :type: string - Specifies an alternative directory to look for stubs instead of the - default ``typeshed`` directory. User home directory and environment - variables will be expanded. + This specifies the directory where mypy looks for standard library typeshed + stubs, instead of the typeshed that ships with mypy. This is + primarily intended to make it easier to test typeshed changes before + submitting them upstream, but also allows you to use a forked version of + typeshed. + + User home directory and environment variables will be expanded. + + Note that this doesn't affect third-party library stubs. To test third-party stubs, + for example try ``MYPYPATH=stubs/six mypy ...``. .. confval:: warn_incomplete_stub