-
-
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
Triage: Confusion between action and executable command handlers #938
Comments
Couple of documentation areas for improving status quo:
|
First steps are looking to resolve #706, and improving documentation (README, JSDoc, TypeScript). |
Pull request including JSDoc and TypeScript improvements underway: #990 |
* TSDoc: defined .command as an overload, with reworked documentstion * Add TSDoc remarks about command description * description is the key difference between the overloads, so be explicit about how it is suppliied. * Rework .command JSDoc to clarify two styles * Minor changes in comments * Rework (sub)command coverage in README * Update CHANGELOG with #938 * Minor improvements to command and argument coverage * Fix indentation in code blocks in README
This issue will be resolved when v3.0.0 is released. Available now as a prerelease. See #1001 Reworked the README and JSDoc and TypeScript to hopefully make the two modes of operation clearer. Have not changed the runtime, but will close this issue and see how the changes help. |
Reworked the README and JSDoc and TypeScript to hopefully make the two modes of operation clearer. Have not changed the runtime, but will close this issue and see how the changes help. Shipped in v3: https://github.com/tj/commander.js/releases/tag/v3.0.0 |
There is a silent change in behaviour based on whether a description parameter is added to the
.command
definition. This is a common cause of confusion. Opened this issue to collect the related issues found during triage.Issues:
Pull Requests:
The text was updated successfully, but these errors were encountered: