Add usage to modify command #429
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds the usage line from the manpage to the modify command for quick reference when called without parameters: ``` $ timew modify Usage: timew modify ( start | end ) <id> <date> Must specify start|end command to modify. See 'timew help modify'. ``` This makes it faster than looking up the syntax in the manpage and helps build faster memory of syntax for users. Signed-off-by: Pat David <[email protected]>
lauft
requested changes
Jun 11, 2021
| @@ -59,7 +59,7 @@ int CmdModify ( | |||
| } | |||
| else | |||
| { | |||
| throw format ("Must specify start|end command to modify. See 'timew help modify'.", words.at (0)); | |||
| throw format ("Usage: timew modify ( start | end ) <id> <date>\nMust specify start|end command to modify. See 'timew help modify'.", words.at (0)); | |||
There was a problem hiding this comment.
I noticed that here the format function does not use the words.at (0) parameter at all.
I think we should change this to something like
Unknown sub-command '{}'!
Usage: timew modify ( start | end ) <id> <date>
Please add the start/end sub-command to 'modify'. See 'timew help modify'.
In action:
$ timew modify strat @2
Unknown sub-command 'strat'!
Usage: timew modify ( start | end ) <id> <date>
Please add the start/end sub-command to 'modify'. See 'timew help modify'.
| @@ -46,7 +46,7 @@ int CmdModify ( | |||
|
|
|||
| if (words.empty()) | |||
| { | |||
| throw std::string ("Must specify start|end command to modify. See 'timew help modify'."); | |||
| throw std::string ("Usage: timew modify ( start | end ) <id> <date>\nMust specify start|end command to modify. See 'timew help modify'."); | |||
There was a problem hiding this comment.
Maybe we can also add some info what went wrong:
Missing sub-command!
Usage: timew modify ( start | end ) <id> <date>
Please add the start/end sub-command to 'modify'. See 'timew help modify'.
e.g.:
$ timew modify @4
Missing sub-command!
Usage: timew modify ( start | end ) <id> <date>
Please add the start/end sub-command to 'modify'. See 'timew help modify'.
|
@patdavid Will there be any update from your side? Otherwise I would just merge your work with the suggested changes myself... |
|
Ah, sorry - this slipped out of memory for me. :( (sorry!) I don't have anything else to add at the moment, although I'm happy to revisit this when I can carve out a little more time and maybe propagate the idea to the rest of the commands for more helpful messages. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds the usage line from the manpage to the modify
command for quick reference when called without parameters:
This makes it faster than looking up the syntax in the manpage and
helps build faster memory of syntax for users.