Skip to content

Improve default cli help #675

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
Merged
merged 6 commits into from
Aug 11, 2022
Merged

Improve default cli help #675

merged 6 commits into from
Aug 11, 2022

Conversation

kevinlacaille
Copy link
Contributor

@kevinlacaille kevinlacaille commented Aug 10, 2022 •
edited
Loading

  • Removed text which referred to API parameters in main CLI help message.
  • Changed description in Data CLI message to refer to its API, not the Orders API.
  • Added description to Subscription CLI help message.
  • Moved the verbosity option description below quiet and version, but cannot go below help, as that must always be the last option listed and cannot be moved.

FYI: @cholmes

Closes #633

@kevinlacaille kevinlacaille requested a review from cholmes August 10, 2022 14:48
@kevinlacaille kevinlacaille self-assigned this Aug 10, 2022
@kevinlacaille kevinlacaille requested review from JuLeeAtPlanet and removed request for cholmes August 10, 2022 14:51
JuLeeAtPlanet
JuLeeAtPlanet reviewed Aug 10, 2022
View reviewed changes
@kevinlacaille kevinlacaille merged commit 09878a9 into main Aug 11, 2022
@kevinlacaille kevinlacaille deleted the improve-default-cli-help branch August 11, 2022 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JuLeeAtPlanet JuLeeAtPlanet JuLeeAtPlanet approved these changes

Assignees

@kevinlacaille kevinlacaille

Labels
documentation
Projects
None yet
Milestone
2.0a3: Iterative Alpha Release
Development

Successfully merging this pull request may close these issues.

Improve default CLI help
3 participants
@kevinlacaille @JuLeeAtPlanet @cholmes