-
Notifications
You must be signed in to change notification settings - Fork 900
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
main: rework usage #4467
main: rework usage #4467
Conversation
remove unused switch case statement and improve/add command specific usage. Signed-off-by: leongross <leon.gross@9elements.com>
From a cluttering perspective, I am unsure if we want to keep all the static usage messages in the middle of the code or refactor it somewhere else, something like |
The message is significantly longer now.... I wonder if we want the old version as the default, and the new one as "more help" somehow? |
The old version is still there. I aligned the usage behavior to big go. |
So with that in mind, what do you think? @dankegel @dkegel-fastly @deadprogram |
@deadprogram what do you think of this? |
If there are no change requests, can we merge this? @dankegel @archie2x @dkegel-fastly @dgryski |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have have nits about the wording of things but more accessible documentation is great.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just noticed in my editor (not visible on github diff view) that there are a few lines with trailing space that should probably be cleaned up.
* limit help to 80 col width * remove inconsistent ':' * remove trailing spaces * rmove spaces woth tabs * reworkd build command Signed-off-by: leongross <leon.gross@9elements.com>
4049d53
to
59647c5
Compare
I think this is an excellent idea! So if nobody objects, I'd like to see this merged :) |
@dgryski I think your change request was already made, no? |
@aykevl keeping it in sync is also a problem I see. First, I think adding this for now is a big improvement to the current state. In the long run it mayb be a good idea to automatically pull this from the website source on a regular basis. I thought how to do this but since the webiste uses html amd css styling this is not trivial to convert. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thank you very much for working on this @leongross and to @dgryski @aykevl @archie2x @dkegel-fastly for reviews. Now squash/merging. |
Remove unused switch case and improve/add command-specific usage from website.