Skip to content

Commit 1a3befe

Browse files
authored
[ty] Update mypy_primer doc (#18638)
## Summary Minor documentation update to make `mypy_primer` instructions a bit more verbose/helpful for running against a local branch ## Test Plan N/A
1 parent 7893cf9 commit 1a3befe

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

crates/ty/docs/mypy_primer.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,19 @@ If you are working on a local branch, you can use `mypy_primer`'s `--repo` optio
5151
This allows `mypy_primer` to check out local branches:
5252

5353
```sh
54-
mypy_primer --repo /path/to/ruff --old origin/main --new my/local-branch …
54+
mypy_primer --type-checker ty \
55+
--repo ./ruff \
56+
--old main \
57+
--new my/local-branch \
58+
--project-selector '/beartype$' \
59+
--debug \
60+
--output concise
5561
```
5662

57-
Note that you might need to clean up `/tmp/mypy_primer` in order for this to work correctly.
63+
Notes:
64+
65+
- You might need to clean up `/tmp/mypy_primer` in order for this to work correctly.
66+
- This must be run from _outside_ the `ruff` repo.
5867

5968
[full list of ecosystem projects]: https://github.com/hauntsaninja/mypy_primer/blob/master/mypy_primer/projects.py
6069
[tool executables]: https://docs.astral.sh/uv/concepts/tools/#tool-executables

0 commit comments

Comments
 (0)