mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-29 13:24:57 +00:00
[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:
parent
7893cf9fe1
commit
1a3befe8d6
1 changed files with 11 additions and 2 deletions
|
@ -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:
|
This allows `mypy_primer` to check out local branches:
|
||||||
|
|
||||||
```sh
|
```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
|
[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
|
[tool executables]: https://docs.astral.sh/uv/concepts/tools/#tool-executables
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue