Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The modify command's help text and documentation updated. #169

Merged
merged 1 commit into from
Mar 7, 2024
Merged

The modify command's help text and documentation updated. #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions dem/cli/main.py
View file
Open in desktop
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
View file
Open in desktop
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
Loading