Skip to content

fix: unify coder create and coder delete help message (#15668) #15752

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.

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

Merged
merged 1 commit into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
fix: unify coder create and coder delete help message
  • Loading branch information
phorcys420 committed Dec 4, 2024
commit 365dded9da8d145803fe5e02c427d5eeac56e11a
2 changes: 1 addition & 1 deletion cli/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func (r *RootCmd) create() *serpent.Command {
client := new(codersdk.Client)
cmd := &serpent.Command{
Annotations: workspaceCommand,
Use: "create [name]",
Use: "create [workspace]",
Short: "Create a workspace",
Long: FormatExamples(
Example{
Expand Down
6 changes: 6 additions & 0 deletions cli/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ func (r *RootCmd) deleteWorkspace() *serpent.Command {
Annotations: workspaceCommand,
Use: "delete <workspace>",
Short: "Delete a workspace",
Long: FormatExamples(
Example{
Description: "Delete a workspace for another user (if you have permission)",
Command: "coder delete <username>/<workspace_name>",
},
),
Middleware: serpent.Chain(
serpent.RequireNArgs(1),
r.InitClient(client),
Expand Down
2 changes: 1 addition & 1 deletion cli/testdata/coder_create_--help.golden
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
coder v0.0.0-devel

USAGE:
coder create [flags] [name]
coder create [flags] [workspace]

Create a workspace

Expand Down
4 changes: 4 additions & 0 deletions cli/testdata/coder_delete_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ USAGE:

Aliases: rm

- Delete a workspace for another user (if you have permission):

$ coder delete <username>/<workspace_name>

OPTIONS:
--orphan bool
Delete a workspace without deleting its resources. This can delete a
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/create.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions docs/reference/cli/delete.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading