From fa07d57caa4979c22676cdd9daebb2b67b5d8f1b Mon Sep 17 00:00:00 2001 From: Jacob Coffee Date: Wed, 25 Sep 2024 23:15:48 -0500 Subject: [PATCH 1/4] doc: add alias context to tool run --help command --- crates/uv-cli/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index 68b4dba9aada..98f4a57b0319 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -3174,6 +3174,11 @@ pub enum ToolCommand { /// /// Packages are installed into an ephemeral virtual environment in the uv /// cache directory. + #[command( + about = "Run a command provided by a Python package. Also available via the alias `uvx`.", + after_help = "You can also use `uvx` as an alias for `uv tool run`. \n\ + Use `uv help tool run` for more details." + )] Run(ToolRunArgs), /// Hidden alias for `uv tool run` for the `uvx` command #[command( From 73d1b393f9b54e46446206afdf73ecbfefa97fbb Mon Sep 17 00:00:00 2001 From: Jacob Coffee Date: Thu, 26 Sep 2024 22:22:03 -0500 Subject: [PATCH 2/4] doc: remove repeated line from short help --- crates/uv-cli/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index 98f4a57b0319..f6dbedbecd51 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -3175,7 +3175,7 @@ pub enum ToolCommand { /// Packages are installed into an ephemeral virtual environment in the uv /// cache directory. #[command( - about = "Run a command provided by a Python package. Also available via the alias `uvx`.", + about = "Also available via the alias `uvx`.", after_help = "You can also use `uvx` as an alias for `uv tool run`. \n\ Use `uv help tool run` for more details." )] From 882b4d395d1d905fa19c5851f7b46260605217d8 Mon Sep 17 00:00:00 2001 From: Jacob Coffee Date: Tue, 8 Oct 2024 16:05:57 -0500 Subject: [PATCH 3/4] chore: address review --- crates/uv-cli/src/lib.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index e6726462074e..c0067e9286b5 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -3263,9 +3263,9 @@ pub enum ToolCommand { /// Packages are installed into an ephemeral virtual environment in the uv /// cache directory. #[command( - about = "Also available via the alias `uvx`.", after_help = "You can also use `uvx` as an alias for `uv tool run`. \n\ - Use `uv help tool run` for more details." + Use `uv help tool run` for more details.", + after_long_help = "" )] Run(ToolRunArgs), /// Hidden alias for `uv tool run` for the `uvx` command From 126441367568bfdba93b442eb35a05f826c3f55c Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Tue, 8 Oct 2024 16:36:44 -0500 Subject: [PATCH 4/4] Tweak --- crates/uv-cli/src/lib.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index c0067e9286b5..80965752b394 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -3263,7 +3263,7 @@ pub enum ToolCommand { /// Packages are installed into an ephemeral virtual environment in the uv /// cache directory. #[command( - after_help = "You can also use `uvx` as an alias for `uv tool run`. \n\ + after_help = "Use `uvx` as a shortcut for `uv tool run`.\n\n\ Use `uv help tool run` for more details.", after_long_help = "" )]