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

Improve mbed-tools --help text #274

Open
rwalton-arm opened this issue Apr 27, 2021 · 0 comments
Open

Improve mbed-tools --help text #274

rwalton-arm opened this issue Apr 27, 2021 · 0 comments
Labels
bug Something isn't working

Comments

@rwalton-arm
Copy link
Contributor

Describe the bug
The help text for mbed-tools looks bad because Click truncates the short help text:

  configure  Generate an Mbed OS config CMake file and write it to a...
  deploy     Checks out Mbed program library dependencies at the revision...

Some of the information is also incorrect:

Options:
  --version        Display versions of all Mbed Tools packages.

We no longer have multiple mbed-tools packages so this text needs to change.

We also have a combination of imperative and indicative mood in the short help:

  import     Clone an Mbed project and library dependencies.
  new        Creates a new Mbed project at the specified path.

We should prefer imperative mood. So in the above example "Creates ..." should be "Create ...".

To Reproduce
Steps to reproduce the behavior:
mbed-tools --help

Expected behavior
Short help text is short enough so Click doesn't truncate it.
Help text information is correct and up-to-date with the current state of the tool.
Command descriptions use imperative mood.

@rwalton-arm rwalton-arm added the bug Something isn't working label Apr 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant