Skip to content

Commit

Permalink
Add note to extra and all-extras in uv sync help (#7013)
Browse files Browse the repository at this point in the history
  • Loading branch information
zanieb authored Sep 4, 2024
1 parent ae144e0 commit 1996067
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
6 changes: 6 additions & 0 deletions crates/uv-cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<Vec<ExtraName>>,

/// 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,

Expand Down
6 changes: 5 additions & 1 deletion docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -1132,7 +1132,9 @@ uv sync [OPTIONS]

<h3 class="cli-reference">Options</h3>

<dl class="cli-reference"><dt><code>--all-extras</code></dt><dd><p>Include all optional dependencies</p>
<dl class="cli-reference"><dt><code>--all-extras</code></dt><dd><p>Include all optional dependencies.</p>

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

</dd><dt><code>--allow-insecure-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>

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

<p>May be provided more than once.</p>

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

</dd><dt><code>--extra-index-url</code> <i>extra-index-url</i></dt><dd><p>Extra URLs of package indexes to use, in addition to <code>--index-url</code>.</p>

<p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>
Expand Down

0 comments on commit 1996067

Please sign in to comment.