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.

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

chore(rust): ockam_command: unify help #3622

Merged
merged 1 commit into from
Oct 12, 2022
Merged

chore(rust): ockam_command: unify help #3622

merged 1 commit into from
Oct 12, 2022

Conversation

hargut
Copy link
Contributor

@hargut hargut commented Oct 8, 2022 •
edited

Current Behavior

extended help is always shown, leading to a situations where the important help flags are only visible when utilizing a pager

Proposed Changes

utilize clap after_long_help to differentiate between compact (-h) and extensive (--help) help
adjust help template to meet headline style from clap v4

References

#3434

Checks

@hargut hargut requested a review from a team as a code owner October 8, 2022 12:53
@hargut hargut force-pushed the feature/use-after-long-help branch from e217f73 to d48169d Compare October 9, 2022 07:27
@hargut hargut changed the title chore(rust): ockam_command: unify help, introduce different help outp… chore(rust): ockam_command: unify help Oct 9, 2022
@hargut hargut mentioned this pull request Oct 9, 2022
Closed
@adrianbenavides adrianbenavides linked an issue Oct 11, 2022 that may be closed by this pull request
Show command help in $PAGER or less #3434
Closed
@hargut hargut force-pushed the feature/use-after-long-help branch from 2ac4824 to 489e083 Compare October 11, 2022 11:54
twittner
twittner reviewed Oct 11, 2022
View reviewed changes
Copy link
Contributor

@twittner twittner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good to me. Would you mind signing the commits?

implementations/rust/ockam/ockam_command/src/help.rs Outdated Show resolved Hide resolved
@hargut hargut force-pushed the feature/use-after-long-help branch from dac469e to 9dc56c9 Compare October 11, 2022 14:59
@hargut @mrinalwadhwa
refactor(rust): unify ockam_command help
f293d0f 
utilize clap after_long_help to differentiate between
compact (-h) and extensive (--help) help output
adjust help templating to match headline style from clap v4
@mrinalwadhwa mrinalwadhwa self-requested a review October 12, 2022 14:42
mrinalwadhwa
mrinalwadhwa approved these changes Oct 12, 2022
View reviewed changes
Copy link
Member

@mrinalwadhwa mrinalwadhwa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for another awesome contribution 🥳
Merging.

@mergify mergify bot merged commit ea29be5 into build-trust:develop Oct 12, 2022
@mrinalwadhwa mrinalwadhwa added the HACKTOBERFEST-ACCEPTED To be used when a PR is ready to merge or after it's merged label Oct 13, 2022
@hargut hargut deleted the feature/use-after-long-help branch December 25, 2022 14:41
@mrinalwadhwa mrinalwadhwa added HACKTOBERFEST-ACCEPTED-2022 and removed HACKTOBERFEST-ACCEPTED To be used when a PR is ready to merge or after it's merged labels Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@twittner twittner twittner left review comments

@mrinalwadhwa mrinalwadhwa mrinalwadhwa approved these changes

Assignees
No one assigned
Labels
HACKTOBERFEST-ACCEPTED-2022
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Show command help in $PAGER or less
3 participants
@hargut @twittner @mrinalwadhwa