Clarify command descriptions when no arguments are taken #496

noerw · 2022-08-26T15:43:21Z

noerw commented

2022-08-26 15:43:21 +00:00

This changes the command help string from eg

NAME:
   tea label create - Create a label

USAGE:
   tea label [command options] [arguments...]

to

NAME:
   tea label create - Create a label

USAGE:
   tea label [command options]

Hopefully improving usability.

edit: this also changes tea release create to take the --tag flag value optionally via the first argument, as this seems to be a clear UX improvement.

fixes #483

This changes the command help string from eg ``` NAME: tea label create - Create a label USAGE: tea label [command options] [arguments...] ``` to ``` NAME: tea label create - Create a label USAGE: tea label [command options] ``` Hopefully improving usability. --- edit: this also changes `tea release create` to take the `--tag` flag value optionally via the first argument, as this seems to be a clear UX improvement. fixes #483

noerw added this to the v0.9.0 milestone 2022-08-26 15:43:21 +00:00

noerw added the

kind/docs

kind

enhancement

labels 2022-08-26 15:43:21 +00:00

noerw added 2 commits 2022-08-26 15:43:22 +00:00

clarify docs for commands that take no arguments 004398f048

release create: accept tag also via argument

continuous-integration/drone/pr Build is failing

Details

8ffb00c5f5

noerw referenced this pull request

2022-08-26 15:50:57 +00:00

Bug: tea release create -- "title is empty" #483

noerw added 1 commit 2022-08-26 15:58:04 +00:00

Merge branch 'main' into fix-483-2

continuous-integration/drone/pr Build is failing

Details

05e9facca1

noerw added 1 commit 2022-09-13 15:41:07 +00:00

fix lint

continuous-integration/drone/pr Build is passing

Details

8cd9da42c7

techknowlogick approved these changes 2022-09-13 16:51:01 +00:00

6543 approved these changes 2022-09-13 17:53:48 +00:00

6543 added 1 commit 2022-09-13 17:53:59 +00:00

Merge branch 'main' into fix-483-2

continuous-integration/drone/pr Build is passing

Details

ce56f79e6d

delvh reviewed 2022-09-13 18:08:12 +00:00

cmd/issues/create.go

						
				@ -19,6 +19,7 @@ var CmdIssuesCreate = cli.Command{

					Aliases:     []string{"c"},

					Usage:       "Create an issue on repository",

					Description: `Create an issue on repository`,

					ArgsUsage:   " ", // command does not accept arguments

delvh commented

2022-09-13 18:06:04 +00:00

Why not empty string?

6543 commented

2022-09-13 18:09:19 +00:00

that would be the default value and we would have the behavior form before

👍 1

delvh marked this conversation as resolved

cmd/releases/create.go

						
				@ -67,1 +68,4 @@

					tag := ctx.String("tag")

					if cmd.Args().Present() {

						if len(tag) != 0 {

delvh commented

2022-09-13 18:07:57 +00:00

Wouldn't it be better to only error when --tag <t1> != <t2>?

Wouldn't it be better to only error when `--tag <t1>` != `<t2>`?

6543 commented

2022-09-13 18:10:55 +00:00

no I would error to "educate the users"

👀 1

delvh marked this conversation as resolved

delvh approved these changes 2022-09-13 18:11:57 +00:00

6543 merged commit 5e7c702e07 into main

2022-09-13 18:14:03 +00:00

6543 referenced this issue from a commit

2022-09-13 18:14:03 +00:00

Clarify command descriptions when no arguments are taken (#496)

6543 deleted branch fix-483-2

2022-09-13 18:14:03 +00:00

Sign in to join this conversation.

No reviewers

No Milestone

No Assignees

4 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: gitea/tea#496