You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Implement a help command, which list all possible commands
For more details of a single command, the user has then do something like
help [command] e.g help next
Example: Add created/due by timestamps to tasks.
Describe how this new feature adds value to the application
The problem is that no everybody knows the command by heart and the user which use this application should be soppused to look at the source code to know which commands are implemented or which keywords he has to use.
Of course, the most command are obvious but somthing like the next command which lists all tasks is not so obvious
Example: Allows users to see the current age of a task, when it was created and when it is due by.
Describe suggested implementation
command overview
help
more details of a specific command
help [command/keyword]
And at the start there should be a hint of the existance of the help command
Additional context
N/A
The text was updated successfully, but these errors were encountered:
Excellent suggestion. We obviously should have a help command, the question is how do we implement it in a way where it won't go out of date...
The best way would be if the individual commands (or handlers) were documented, and the help command could pull the documentation from them. That way, if a new command is added you must add documentation to it, or the program wont compile/run.
Elevator pitch: Help Command
Implement a help command, which list all possible commands
For more details of a single command, the user has then do something like
help [command] e.g help next
Example: Add created/due by timestamps to tasks.
Describe how this new feature adds value to the application
The problem is that no everybody knows the command by heart and the user which use this application should be soppused to look at the source code to know which commands are implemented or which keywords he has to use.
Of course, the most command are obvious but somthing like the next command which lists all tasks is not so obvious
Example: Allows users to see the current age of a task, when it was created and when it is due by.
Describe suggested implementation
command overview
more details of a specific command
And at the start there should be a hint of the existance of the help command
Additional context
N/A
The text was updated successfully, but these errors were encountered: