From 48b70bb2596899e26ad16275e3bf1a3aa882ee1f Mon Sep 17 00:00:00 2001 From: Jukka Lehtosalo Date: Tue, 2 Jun 2020 13:04:22 +0100 Subject: [PATCH] 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. --- docs/source/mypy_daemon.rst | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/docs/source/mypy_daemon.rst b/docs/source/mypy_daemon.rst index ff91e476dfd4..3fa6029bd679 100644 --- a/docs/source/mypy_daemon.rst +++ b/docs/source/mypy_daemon.rst @@ -40,28 +40,24 @@ Use ``dmypy run -- `` to typecheck a set of files You can use almost arbitrary mypy flags after ``--``. The daemon will always run on the current host. Example:: - dmypy run -- --follow-imports=error prog.py pkg1/ pkg2/ - -.. note:: - You'll need to use either the :option:`--follow-imports=error ` or the - :option:`--follow-imports=skip ` option with dmypy because the current - implementation can't follow imports. - See :ref:`follow-imports` for details on how these work. - You can also define these using a - :ref:`configuration file `. + dmypy run -- prog.py pkg/*.py ``dmypy run`` will automatically restart the daemon if the configuration or mypy version changes. -You need to provide all files or directories you want to type check -(other than stubs) as arguments. This is a result of the -:option:`--follow-imports ` restriction mentioned above. - The initial run will process all the code and may take a while to finish, but subsequent runs will be quick, especially if you've only -changed a few files. You can use :ref:`remote caching ` +changed a few files. (You can use :ref:`remote caching ` to speed up the initial run. The speedup can be significant if -you have a large codebase. +you have a large codebase.) + +.. note:: + + Mypy 0.780 added support for following imports in dmypy (enabled by + default). This functionality is still experimental. You can use + ``--follow-imports=skip`` or ``--follow-imports=error`` to fall + back to the stable functionality. See :ref:`follow-imports` for + details on how these work. Daemon client commands **********************