Skip to content

Commit 387be66

Browse files
JukkaLIvan Levkivskyi
authored andcommitted
Update docs to reflect that following imports is supported in dmypy (#8930)
Mark this as experimental, since this hasn't been tested a lot yet.
1 parent d32ec7e commit 387be66

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

docs/source/mypy_daemon.rst

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,28 +40,24 @@ Use ``dmypy run -- <flags> <files>`` to typecheck a set of files
4040
You can use almost arbitrary mypy flags after ``--``. The daemon
4141
will always run on the current host. Example::
4242

43-
dmypy run -- --follow-imports=error prog.py pkg1/ pkg2/
44-
45-
.. note::
46-
You'll need to use either the :option:`--follow-imports=error <mypy --follow-imports>` or the
47-
:option:`--follow-imports=skip <mypy --follow-imports>` option with dmypy because the current
48-
implementation can't follow imports.
49-
See :ref:`follow-imports` for details on how these work.
50-
You can also define these using a
51-
:ref:`configuration file <config-file>`.
43+
dmypy run -- prog.py pkg/*.py
5244

5345
``dmypy run`` will automatically restart the daemon if the
5446
configuration or mypy version changes.
5547

56-
You need to provide all files or directories you want to type check
57-
(other than stubs) as arguments. This is a result of the
58-
:option:`--follow-imports <mypy --follow-imports>` restriction mentioned above.
59-
6048
The initial run will process all the code and may take a while to
6149
finish, but subsequent runs will be quick, especially if you've only
62-
changed a few files. You can use :ref:`remote caching <remote-cache>`
50+
changed a few files. (You can use :ref:`remote caching <remote-cache>`
6351
to speed up the initial run. The speedup can be significant if
64-
you have a large codebase.
52+
you have a large codebase.)
53+
54+
.. note::
55+
56+
Mypy 0.780 added support for following imports in dmypy (enabled by
57+
default). This functionality is still experimental. You can use
58+
``--follow-imports=skip`` or ``--follow-imports=error`` to fall
59+
back to the stable functionality. See :ref:`follow-imports` for
60+
details on how these work.
6561

6662
Daemon client commands
6763
**********************

0 commit comments

Comments
 (0)