mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-09-26 20:19:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Improve the uv tree CLI documentation (#5917)

Browse source 
Some small follow-ups.
This commit is contained in:
Zanie Blue 2024-08-08 13:21:46 -05:00 • committed by GitHub
parent d2681320d3
commit f4576fe4a7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

28
crates/uv-cli/src/lib.rs
View file

@ -2107,8 +2107,8 @@ pub struct RunArgs {
/// Assert that the `uv.lock` will remain unchanged.
///
/// Requires that the lockfile is up-to-date. If the lockfile is missing, or
/// if it needs to be updated, uv will exit with an error.
/// Requires that the lockfile is up-to-date. If the lockfile is missing or
/// needs to be updated, uv will exit with an error.
#[arg(long, conflicts_with = "frozen")]
pub locked: bool,
@ -2357,8 +2357,8 @@ pub struct AddArgs {
/// Assert that the `uv.lock` will remain unchanged.
///
/// Requires that the lockfile is up-to-date. If the lockfile is missing, or
/// if it needs to be updated, uv will exit with an error.
/// Requires that the lockfile is up-to-date. If the lockfile is missing or
/// needs to be updated, uv will exit with an error.
#[arg(long, conflicts_with = "frozen")]
pub locked: bool,
@ -2416,8 +2416,8 @@ pub struct RemoveArgs {
/// Assert that the `uv.lock` will remain unchanged.
///
/// Requires that the lockfile is up-to-date. If the lockfile is missing, or
/// if it needs to be updated, uv will exit with an error.
/// Requires that the lockfile is up-to-date. If the lockfile is missing or
/// needs to be updated, uv will exit with an error.
#[arg(long, conflicts_with = "frozen")]
pub locked: bool,
@ -2457,8 +2457,13 @@ pub struct RemoveArgs {
#[derive(Args)]
#[allow(clippy::struct_excessive_bools)]
pub struct TreeArgs {
/// Show the resolved package versions for all Python versions and platforms, rather than
/// filtering to those that are relevant for the current environment.
/// Show a platform-independent dependency tree.
///
/// Shows resolved package versions for all Python versions and platforms,
/// rather than filtering to those that are relevant for the current
/// environment.
///
/// Multiple versions may be shown for a each package.
#[arg(long)]
pub universal: bool,
@ -2466,10 +2471,15 @@ pub struct TreeArgs {
pub tree: DisplayTreeArgs,
/// Assert that the `uv.lock` will remain unchanged.
///
/// Requires that the lockfile is up-to-date. If the lockfile is missing or
/// needs to be updated, uv will exit with an error.
#[arg(long, conflicts_with = "frozen")]
pub locked: bool,
/// Display the requirements without updating the `uv.lock` file.
/// Display the requirements without locking the project.
///
/// If the lockfile is missing, uv will exit with an error.
#[arg(long, conflicts_with = "locked")]
pub frozen: bool,