Skip to content

Commit

Permalink
Help text and docs updated for the modify command.
Browse files Browse the repository at this point in the history
  • Loading branch information
janosmurai committed Mar 7, 2024
1 parent 27bd555 commit 5879162
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions dem/cli/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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]

---
Expand Down

0 comments on commit 5879162

Please sign in to comment.