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 help messages and flag explanations #7

Open
maxRN opened this issue Feb 20, 2022 · 3 comments
Open

Improve help messages and flag explanations #7

maxRN opened this issue Feb 20, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@maxRN
Copy link
Owner

maxRN commented Feb 20, 2022

Currently most flags and commands don't have a proper explanation or examples.

Many still display the default cobra help message.

@maxRN maxRN added enhancement New feature or request good first issue Good for newcomers documentation Improvements or additions to documentation labels Feb 20, 2022
@joaoepj
Copy link
Contributor

joaoepj commented Mar 22, 2022

Hello Max!

Whats up? I was wondering if you have interest in the feature of showing the release version on command messages. Also, in eliminate the word Error: from messages and move them to the bottom, this make me feel things are too bad.

@maxRN
Copy link
Owner Author

maxRN commented Mar 27, 2022

Hi @joaoepj, regarding the versions: sounds good, I'm open to anything really :) Just open a PR and I will have a look.
I'm not sure I know what you mean in regards to the Error messages. Do you have an example of what your want to change?

@joaoepj
Copy link
Contributor

joaoepj commented Mar 27, 2022

Ok! I'll do my homework and eventually open the PR. I realize the error messages are a feature of cobra lib and need to do more tests.

Hi @joaoepj, regarding the versions: sounds good, I'm open to anything really :) Just open a PR and I will have a look. I'm not sure I know what you mean in regards to the Error messages. Do you have an example of what your want to change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants