Skip to content
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

Help command #34

Open
unbekanntunity opened this issue May 22, 2021 · 2 comments
Open

Help command #34

unbekanntunity opened this issue May 22, 2021 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@unbekanntunity
Copy link
Contributor

unbekanntunity commented May 22, 2021

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

  • 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

@unbekanntunity unbekanntunity added the enhancement New feature or request label May 22, 2021
@pobiega
Copy link
Collaborator

pobiega commented May 22, 2021

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.

@unbekanntunity unbekanntunity self-assigned this May 22, 2021
@unbekanntunity
Copy link
Contributor Author

Alright will start today or tomorrow with that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants