From 113ae87ab4712234b749fb65a3b03bd659ca6bae Mon Sep 17 00:00:00 2001 From: Nick Janetakis Date: Mon, 24 Mar 2025 11:45:29 -0400 Subject: [PATCH] Update `--prune` help arg from `PRUNE` to `PACKAGE` (#12432) ## Summary This fixes https://github.com/astral-sh/uv/issues/12426 which helps use a more accurate arg name in the help output. ## Test Plan I didn't test it locally, @charliermarsh gave me guidance on what to change so I looked around that file for another example of `value_name` and repeated what I saw. I kept it formatted to 1 line based on it not being a long line. The other example of `value_name` had everything on separate lines because there were a bunch of parameters passed in. --------- Co-authored-by: Charlie Marsh --- crates/uv-cli/src/lib.rs | 2 +- docs/reference/cli.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index c8a1017b4..501db96b3 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -3769,7 +3769,7 @@ pub struct ExportArgs { /// /// Pruned packages will be excluded from the exported requirements file, as will any /// dependencies that are no longer required after the pruned package is removed. - #[arg(long, conflicts_with = "all_packages")] + #[arg(long, conflicts_with = "all_packages", value_name = "PACKAGE")] pub prune: Vec, /// Include optional dependencies from the specified extra name. diff --git a/docs/reference/cli.md b/docs/reference/cli.md index ac8a3901d..3273bba63 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -2542,7 +2542,7 @@ uv export [OPTIONS]

This setting has no effect when used in the uv pip interface.

-
--prune prune

Prune the given package from the dependency tree.

+
--prune package

Prune the given package from the dependency tree.

Pruned packages will be excluded from the exported requirements file, as will any dependencies that are no longer required after the pruned package is removed.