Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <charlie.r.marsh@gmail.com>
This commit is contained in:
Nick Janetakis 2025-03-24 11:45:29 -04:00 committed by GitHub
parent 1865e0a6ee
commit 113ae87ab4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/uv-cli/src/lib.rs
View File

@ -3769,7 +3769,7 @@ pub struct ExportArgs {
/// ///
/// Pruned packages will be excluded from the exported requirements file, as will any /// 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. /// 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<PackageName>, pub prune: Vec<PackageName>,
/// Include optional dependencies from the specified extra name. /// Include optional dependencies from the specified extra name.

2
docs/reference/cli.md
View File

@ -2542,7 +2542,7 @@ uv export [OPTIONS]
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p> <p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
</dd><dt id="uv-export--prune"><a href="#uv-export--prune"><code>--prune</code></a> <i>prune</i></dt><dd><p>Prune the given package from the dependency tree.</p> </dd><dt id="uv-export--prune"><a href="#uv-export--prune"><code>--prune</code></a> <i>package</i></dt><dd><p>Prune the given package from the dependency tree.</p>
<p>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.</p> <p>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.</p>