Add note to extra and all-extras in uv sync help (#7013)

This commit is contained in:
Zanie Blue 2024-09-04 10:05:21 -05:00 committed by GitHub
parent ae144e05ac
commit 1996067f81
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 11 additions and 1 deletions

View file

@ -2368,10 +2368,16 @@ pub struct SyncArgs {
/// Include optional dependencies from the extra group name. /// Include optional dependencies from the extra group name.
/// ///
/// May be provided more than once. /// 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)] #[arg(long, conflicts_with = "all_extras", value_parser = extra_name_with_clap_error)]
pub extra: Option<Vec<ExtraName>>, pub extra: Option<Vec<ExtraName>>,
/// Include all optional dependencies. /// 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")] #[arg(long, conflicts_with = "extra")]
pub all_extras: bool, pub all_extras: bool,

View file

@ -1132,7 +1132,9 @@ uv sync [OPTIONS]
<h3 class="cli-reference">Options</h3> <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> </dd><dt><code>--allow-insecure-host</code> <i>allow-insecure-host</i></dt><dd><p>Allow insecure connections to a host.</p>
@ -1183,6 +1185,8 @@ uv sync [OPTIONS]
<p>May be provided more than once.</p> <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> </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> <p>Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.</p>