Minor formatting tweaks (#9)

This commit is contained in:
Zanie Blue
2026-01-09 06:43:54 -06:00
committed by GitHub
parent e4664cfe19
commit e5a1476849
2 changed files with 12 additions and 12 deletions
+4 -4
View File
@@ -27,11 +27,11 @@ However, avoid making unnecessary changes:
## How to invoke ruff
- **`uv run ruff ...`** (recommended) - Use when ruff is in the project's
dependencies to ensure you use the pinned version
- **`uvx ruff ...`** - Use when ruff is not a project dependency, or for quick
- `uv run ruff ...` - Use when ruff is in the project's dependencies to ensure
you use the pinned version
- `uvx ruff ...` - Use when ruff is not a project dependency, or for quick
one-off checks
- **`ruff ...`** - Use if ruff is installed globally
- `ruff ...` - Use if ruff is installed globally
## Commands
+8 -8
View File
@@ -19,11 +19,11 @@ mypy, Pyright, and other type checkers.
## How to invoke ty
- **`uv run ty ...`** (recommended) - Use when ty is in the project's
dependencies to ensure you use the pinned version
- **`uvx ty ...`** - Use when ty is not a project dependency, or for quick
one-off checks
- **`ty ...`** - Use if ty is installed globally
- `uv run ty ...` - Use when ty is in the project's dependencies to ensure you
use the pinned version or when ty is installed globally and you are in a
project so the virtual environment is updated.
- `uvx ty ...` - Use when ty is not a project dependency, or for quick one-off
checks
## Commands
@@ -117,13 +117,13 @@ explicitly requested by the user. Use `ty: ignore`, not `type: ignore`, and
prefer rule-specific ignores:
```python
# Prefer: rule-specific ignore
# Good: rule-specific ignore
x = undefined_var # ty: ignore[possibly-unresolved-reference]
# Avoid: blanket ignore
# Bad: blanket ty ignore
x = undefined_var # ty: ignore
# Don't use type: ignore
# Bad: tool agnostic blanket ignore
x = undefined_var # type: ignore
```