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.

Sign up for GitHub

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

Jump to bottom

Rework docs to clarify action vs executable commands #990

Merged
merged 9 commits into from
Jul 10, 2019
Merged

Rework docs to clarify action vs executable commands #990

merged 9 commits into from
Jul 10, 2019

Conversation

shadowspawn
Copy link
Collaborator

@shadowspawn shadowspawn commented Jul 5, 2019 •
edited
Loading

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).

  • examples just action vs command
  • change TypeScript to overloaded function, which is appropriate because return type different
  • change JSDoc to have longer param names giving more clues about what might be
  • fix JSDoc param types

Hopefully reduce confusion: #938

Still to come: similar rework for README.

@shadowspawn shadowspawn added this to the v3.0.0 milestone Jul 5, 2019
@shadowspawn shadowspawn mentioned this pull request Jul 7, 2019
Closed
@shadowspawn
Copy link
Collaborator Author

Reworked README coverage of commands. Moving out of draft.

@shadowspawn shadowspawn marked this pull request as ready for review July 7, 2019 08:27
shadowspawn
shadowspawn commented Jul 8, 2019
View reviewed changes
Readme.md Outdated Show resolved Hide resolved
shadowspawn
shadowspawn commented Jul 8, 2019
View reviewed changes
Readme.md Outdated Show resolved Hide resolved
shadowspawn
shadowspawn commented Jul 8, 2019
View reviewed changes
Readme.md Outdated Show resolved Hide resolved
@shadowspawn shadowspawn mentioned this pull request Jul 8, 2019
Merged
abetomo
abetomo approved these changes Jul 10, 2019
View reviewed changes
Copy link
Collaborator

@abetomo abetomo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

abetomo
abetomo reviewed Jul 10, 2019
View reviewed changes
Readme.md Outdated Show resolved Hide resolved
@shadowspawn
Copy link
Collaborator Author

Thanks for review @abetomo.
I will make indentation consistent.

@shadowspawn shadowspawn merged commit fe7850a into tj:release/3.0.0 Jul 10, 2019
@shadowspawn shadowspawn added the pending release Merged into a branch for a future release, but not released yet label Jul 10, 2019
@shadowspawn
Copy link
Collaborator Author

Plan to close #521 when this lands as have added example of getting property in action handler

@shadowspawn shadowspawn deleted the feature/938-command-docs branch July 27, 2019 07:41
@shadowspawn
Copy link
Collaborator Author

Shipped in v3: https://github.com/tj/commander.js/releases/tag/v3.0.0

@shadowspawn shadowspawn removed the pending release Merged into a branch for a future release, but not released yet label Aug 12, 2019
This was referenced Dec 30, 2021
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abetomo abetomo abetomo approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@shadowspawn @abetomo