Skip to content

Commit

Permalink
(doc) Fix wrong examples for locking (astral-sh#7120)
Browse files Browse the repository at this point in the history
## Summary

The examples for compile with optional dependencies use `uv pip install`
instead of `uv pip compile` (probably a copy-paste error)

## Test Plan
N/A  This is a minor doc issue. The result is directly rendered.
  • Loading branch information
cpascual authored Sep 6, 2024
1 parent 346147d commit 1b6638f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/pip/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ $ echo "ruff" | uv pip compile -
To lock with optional dependencies enabled, e.g., the "foo" extra:

```console
$ uv pip install -r pyproject.toml --extra foo
$ uv pip compile pyproject.toml --extra foo
```

To lock with all optional dependencies enabled:

```console
$ uv pip install -r pyproject.toml --all-extras
$ uv pip compile pyproject.toml --all-extras
```

Note extras are not supported with the `requirements.in` format.
Expand Down

0 comments on commit 1b6638f

Please sign in to comment.