[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
This commit is contained in:
justin 2025-06-11 23:50:37 -04:00 committed by GitHub
parent 7893cf9fe1
commit 1a3befe8d6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -51,10 +51,19 @@ If you are working on a local branch, you can use `mypy_primer`'s `--repo` optio
This allows `mypy_primer` to check out local branches:
```sh
mypy_primer --repo /path/to/ruff --old origin/main --new my/local-branch …
mypy_primer --type-checker ty \
--repo ./ruff \
--old main \
--new my/local-branch \
--project-selector '/beartype$' \
--debug \
--output concise
```
Note that you might need to clean up `/tmp/mypy_primer` in order for this to work correctly.
Notes:
- You might need to clean up `/tmp/mypy_primer` in order for this to work correctly.
- This must be run from _outside_ the `ruff` repo.
[full list of ecosystem projects]: https://github.com/hauntsaninja/mypy_primer/blob/master/mypy_primer/projects.py
[tool executables]: https://docs.astral.sh/uv/concepts/tools/#tool-executables