improve-command-error-messages #195

Merged
sloum merged 6 commits from improve-command-error-messages into release2.3.3 2020-11-02 02:53:24 +00:00
Owner

This adds to the existing help improvements so that you can type things like :help add and get the correct syntax for the command. I believe asdf, or maybe myself (?), already fixed things up so that if you type in a mangled command you will be given a message with the correct command syntax. This just cleans that up a bit to allow for using help in the same way.

Typing just :help will stillnavigate you to the bombadillo gopher page.

This should complete the stopgap measures until a full integrated help manual can be released (not happening as a part of 2.3.3).

@asdf , since this involves code you were working with do you mind trying it out?

This adds to the existing help improvements so that you can type things like `:help add` and get the correct syntax for the command. I believe asdf, or maybe myself (?), already fixed things up so that if you type in a mangled command you will be given a message with the correct command syntax. This just cleans that up a bit to allow for using help in the same way. Typing just `:help` will stillnavigate you to the bombadillo gopher page. This should complete the stopgap measures until a full integrated help manual can be released (not happening as a part of 2.3.3). @asdf , since this involves code you were working with do you mind trying it out?
asdf was assigned by sloum 2020-11-01 05:17:04 +00:00
asdf reviewed 2020-11-01 10:07:44 +00:00
client.go Outdated
@ -358,1 +358,4 @@
c.DrawMessage()
case "HELP", "?":
if val, ok := ERRS[values[0]]; ok {
c.SetMessage(val, false)
Collaborator

To ensure the help message is shown in context, we should prefix the message with "Usage: " or something?

To ensure the help message is shown in context, we should prefix the message with "Usage: " or something?
Collaborator

Really elegant and a good outcome. Apart from the comment I've made, I pushed a small correction to the help text which I missed when implementing it initially. Should be good to go!

Really elegant and a good outcome. Apart from the comment I've made, I pushed a small correction to the help text which I missed when implementing it initially. Should be good to go!
Author
Owner

Awesome :-D I have added the Usage: [...] prefix for help output per your comment. Let me know if that is what you had in mind. If so, I think this is probably ready to merge in.

Awesome :-D I have added the `Usage: [...]` prefix for help output per your comment. Let me know if that is what you had in mind. If so, I think this is probably ready to merge in.
asdf approved these changes 2020-11-02 02:15:25 +00:00
sloum merged commit a6375ecc21 into release2.3.3 2020-11-02 02:53:24 +00:00
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
2 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: sloum/bombadillo#195
No description provided.