Clarify documentation for `--no-index` (#1243)

Closes #1242.
This commit is contained in:
Charlie Marsh 2024-02-04 15:46:01 -08:00 committed by GitHub
parent 8116f6131a
commit 9d42cfd09b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 5 deletions

View File

@ -227,7 +227,8 @@ struct PipCompileArgs {
#[clap(long)] #[clap(long)]
extra_index_url: Vec<IndexUrl>, extra_index_url: Vec<IndexUrl>,
/// Ignore the package index, instead relying on local archives and caches. /// Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those
/// discovered via `--find-links`.
#[clap(long, conflicts_with = "index_url", conflicts_with = "extra_index_url")] #[clap(long, conflicts_with = "index_url", conflicts_with = "extra_index_url")]
no_index: bool, no_index: bool,
@ -342,8 +343,8 @@ struct PipSyncArgs {
#[clap(long)] #[clap(long)]
find_links: Vec<FlatIndexLocation>, find_links: Vec<FlatIndexLocation>,
/// Ignore the registry index (e.g., PyPI), instead relying on local caches and `--find-links` /// Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those
/// directories and URLs. /// discovered via `--find-links`.
#[clap(long, conflicts_with = "index_url", conflicts_with = "extra_index_url")] #[clap(long, conflicts_with = "index_url", conflicts_with = "extra_index_url")]
no_index: bool, no_index: bool,
@ -481,7 +482,8 @@ struct PipInstallArgs {
#[clap(long)] #[clap(long)]
find_links: Vec<FlatIndexLocation>, find_links: Vec<FlatIndexLocation>,
/// Ignore the package index, instead relying on local archives and caches. /// Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those
/// discovered via `--find-links`.
#[clap(long, conflicts_with = "index_url", conflicts_with = "extra_index_url")] #[clap(long, conflicts_with = "index_url", conflicts_with = "extra_index_url")]
no_index: bool, no_index: bool,
@ -596,7 +598,8 @@ struct VenvArgs {
#[clap(long)] #[clap(long)]
extra_index_url: Vec<IndexUrl>, extra_index_url: Vec<IndexUrl>,
/// Ignore the package index, instead relying on local archives and caches. /// Ignore the registry index (e.g., PyPI), instead relying on direct URL dependencies and those
/// discovered via `--find-links`.
#[clap(long, conflicts_with = "index_url", conflicts_with = "extra_index_url")] #[clap(long, conflicts_with = "index_url", conflicts_with = "extra_index_url")]
no_index: bool, no_index: bool,
} }