From e4c6a89c158eb32d8b337b26ada409448aab588b Mon Sep 17 00:00:00 2001 From: janosmurai Date: Thu, 7 Mar 2024 18:09:35 +0100 Subject: [PATCH] Help text and docs updated for the modify command. --- dem/cli/main.py | 5 +++-- docs/commands.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/dem/cli/main.py b/dem/cli/main.py index a79ce0b..583c64d 100644 --- a/dem/cli/main.py +++ b/dem/cli/main.py @@ -181,10 +181,11 @@ def rename(dev_env_name: Annotated[str, typer.Argument(help="Name of the Develop @typer_cli.command() def modify(dev_env_name: Annotated[str, typer.Argument(help="Name of the Development Environment to modify.", autocompletion=autocomplete_dev_env_name)], - tool_type: Annotated[str, typer.Argument(help="The tool type to modify.")] = "", + tool_type: Annotated[str, typer.Argument(help="The tool type to change.")] = "", tool_image: Annotated[str, typer.Argument(help="The tool image to set for the tool type.")] = "") -> None: """ - Modify a tool in a Development Environment. + Change a tool in a Development Environment. + If the tool type is not specified, the Dev Env settings panel will be opened. """ if platform: diff --git a/docs/commands.md b/docs/commands.md index 47b601c..b72dd57 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -88,7 +88,7 @@ Arguments: ## **`dem modify DEV_ENV_NAME`** -Modify a tool in a Development Environment. +Change a tool in a Development Environment. If the tool type is not specified, the Dev Env settings panel will be opened: @@ -108,7 +108,7 @@ Select the required tool image and press :material-keyboard-return:. Arguments: `DEV_ENV_NAME` Name of the Development Environment to modify. [required] -`[TOOL_TYPE]` The type of the tool to modify. [optional] +`[TOOL_TYPE]` The tool type to change. [optional] `[TOOL_IMAGE]` The tool image to set for the tool type. [optional] ---