paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 05:23:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

developer docs: Recommend the mypy daemon for running mypy locally.

Browse Source 
Resolves #10622.
This commit is contained in:
Jack Zhang
2018-10-09 18:07:29 -07:00
committed by Tim Abbott
parent c57c4cf703
commit d60a088a49
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/contributing/mypy.md
View File

@@ -110,11 +110,23 @@ requirements/mypy.txt`.
## Running mypy on Zulip's code locally
To run mypy on Zulip's python code, run the command:
To run mypy on Zulip's python code, you can run the command:
tools/run-mypy
It will output errors in the same style as a compiler would. For
You can also run mypy as a long-running daemon (server) process and send
type-checking requests to the server via the command:
tools/run-mypy -d
While the mypy daemon is experimental and currently supports macOS and Linux
only, **we strongly recommend using the daemon** if it is an option. Program
state from previous runs will be cached in memory and will not have to be
read from the file system on each run. For a large codebase like Zulip's
and a workflow involving running mypy repeatedly after small edits, using
the daemon can be *10 or more times faster*.
Mypy will output errors in the same style as a compiler would. For
example, if your code has a type error like this:
```