From 9d42cfd09bd7c91fd47df87935a6ad2de8f6c9b8 Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Sun, 4 Feb 2024 15:46:01 -0800 Subject: [PATCH] Clarify documentation for `--no-index` (#1243) Closes #1242. --- crates/puffin/src/main.rs | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/crates/puffin/src/main.rs b/crates/puffin/src/main.rs index 363a55c17..0fca998e2 100644 --- a/crates/puffin/src/main.rs +++ b/crates/puffin/src/main.rs @@ -227,7 +227,8 @@ struct PipCompileArgs { #[clap(long)] extra_index_url: Vec, - /// 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")] no_index: bool, @@ -342,8 +343,8 @@ struct PipSyncArgs { #[clap(long)] find_links: Vec, - /// Ignore the registry index (e.g., PyPI), instead relying on local caches and `--find-links` - /// directories and URLs. + /// 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")] no_index: bool, @@ -481,7 +482,8 @@ struct PipInstallArgs { #[clap(long)] find_links: Vec, - /// 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")] no_index: bool, @@ -596,7 +598,8 @@ struct VenvArgs { #[clap(long)] extra_index_url: Vec, - /// 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")] no_index: bool, }