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

Show the script of a task in help dialog #52

Open
agilgur5 opened this issue Sep 2, 2018 · 0 comments
Open

Show the script of a task in help dialog #52

agilgur5 opened this issue Sep 2, 2018 · 0 comments

Comments

@agilgur5
Copy link

agilgur5 commented Sep 2, 2018

Some tasks are self-explanatory if you looked at their script and need no description. I also think knowing what script the task actually runs can be helpful context if only reading from the help dialog and not the maidfile itself.

For instance, I have a clean task that just runs rm -rf build/. If the help dialog outputted this, I wouldn't need to add a description, but since it doesn't I have to add the redundant description of "Cleans the build/ folder".
Tasks without a description also say "No description" instead of not showing anything (potentially a separate issue/PR to address)

nps's help dialog does output the actual script of the task. When no description is given, it will only show the script (never says "No description").

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

No branches or pull requests

1 participant