From 1a3befe8d639aba12e666fd8f3e7cc96bb666197 Mon Sep 17 00:00:00 2001 From: justin Date: Wed, 11 Jun 2025 23:50:37 -0400 Subject: [PATCH] [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 --- crates/ty/docs/mypy_primer.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/crates/ty/docs/mypy_primer.md b/crates/ty/docs/mypy_primer.md index 95345c6282..26cc17c238 100644 --- a/crates/ty/docs/mypy_primer.md +++ b/crates/ty/docs/mypy_primer.md @@ -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