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 ockam enroll —-help text by adding doc comment for verbose flag #6055

Closed
nazmulidris opened this issue Sep 24, 2023 · 3 comments · Fixed by #6197
Closed

Improve ockam enroll —-help text by adding doc comment for verbose flag #6055

nazmulidris opened this issue Sep 24, 2023 · 3 comments · Fixed by #6197

Comments

@nazmulidris
Copy link
Contributor

nazmulidris commented Sep 24, 2023

Context

When a user types ockam enroll —-help in their terminal, they are presented with long help text. You can improve this text content by adding the help information for the --verbose flag, which is confusing right now.

To install Ockam command from a prebuilt binary or from source, please take a look at this README.md.

Current behavior

  1. When you run ockam enroll --help in your terminal you will see the following help text.

Image

Suggested fix

Add doc comment to GlobalArgs::verbose field:

/// Increase verbosity of trace messages by repeating the flag. Learn more at https://crates.io/crates/clap-verbosity-flag”

Make the change to GlobalArgs in this file: /ockam_command/src/lib.rs#L159.

Once the fix is applied, it should look like the following.

Image


We love helping new contributors!


We love helping new contributors! ❤️
If you have questions or need help as you explore, please join us on Discord. If you're looking for other issues to contribute to, please checkout our good first issues.

@rjtch
Copy link
Contributor

rjtch commented Sep 27, 2023

Hey @nazmulidris i want to work on this task and this one #6064

@nazmulidris
Copy link
Contributor Author

@rjtch Awesome, this is all yours. Let us know if you have any questions as you explore.

@nazmulidris
Copy link
Contributor Author

@rjtch In order to be able to assign you to the other issue #6064 , please make a comment on that issue and I will be able to do so 👍🏽

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants