From 1996067f819a806b30b012d2857c21e4040cc70c Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Wed, 4 Sep 2024 10:05:21 -0500 Subject: [PATCH] Add note to `extra` and `all-extras` in `uv sync` help (#7013) --- crates/uv-cli/src/lib.rs | 6 ++++++ docs/reference/cli.md | 6 +++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index 37acc18a4077..5f168ab78d0d 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -2368,10 +2368,16 @@ pub struct SyncArgs { /// Include optional dependencies from the extra group name. /// /// May be provided more than once. + /// + /// Note that all optional dependencies are always included in the resolution; this option only + /// affects the selection of packages to install. #[arg(long, conflicts_with = "all_extras", value_parser = extra_name_with_clap_error)] pub extra: Option>, /// Include all optional dependencies. + /// + /// Note that all optional dependencies are always included in the resolution; this option only + /// affects the selection of packages to install. #[arg(long, conflicts_with = "extra")] pub all_extras: bool, diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 4ba82d500610..94008f4efce9 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -1132,7 +1132,9 @@ uv sync [OPTIONS]

Options

-
--all-extras

Include all optional dependencies

+
--all-extras

Include all optional dependencies.

+ +

Note that all optional dependencies are always included in the resolution; this option only affects the selection of packages to install.

--allow-insecure-host allow-insecure-host

Allow insecure connections to a host.

@@ -1183,6 +1185,8 @@ uv sync [OPTIONS]

May be provided more than once.

+

Note that all optional dependencies are always included in the resolution; this option only affects the selection of packages to install.

+
--extra-index-url extra-index-url

Extra URLs of package indexes to use, in addition to --index-url.

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.