-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Rework docs to clarify action vs executable commands #990
Rework docs to clarify action vs executable commands #990
Conversation
Description is the key difference between the overloads, so be explicit about how it is suppliied.
Reworked README coverage of commands. Moving out of draft. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Thanks for review @abetomo. |
Plan to close #521 when this lands as have added example of getting property in action handler |
Shipped in v3: https://github.com/tj/commander.js/releases/tag/v3.0.0 |
Previous
.command
docs were covering whole program, and not describing git-style usage. Rework to clarify and focus on action vs command (which is subtle).Hopefully reduce confusion: #938
Still to come: similar rework for README.