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

new: Break out command help page logic; sort actions in output #638

Merged
merged 1 commit into from
Sep 16, 2024

Conversation

lgarber-akamai
Copy link
Contributor

@lgarber-akamai lgarber-akamai commented Aug 28, 2024

📝 Description

This pull request breaks the CLI command help page logic out into a separate function and implements the logic to sort action entries by name. This should improve the readability of certain groups since the order of actions in the spec is not guaranteed to be readable.

Additionally, this PR adds a new test case to validate the output of this help page.

✔️ How to Test

The following test steps expect you have pulled down this PR and run make install.

Unit Testing

make testunit

Manual Testing

  1. View the help page for a single CLI command/group:
linode-cli networking --help
  1. Ensure all printed actions are sorted by name.

@lgarber-akamai lgarber-akamai added the improvement for improvements in existing functionality in the changelog. label Aug 28, 2024
@lgarber-akamai lgarber-akamai requested a review from a team as a code owner August 28, 2024 16:37
@lgarber-akamai lgarber-akamai requested review from zliang-akamai and yec-akamai and removed request for a team August 28, 2024 16:37
Copy link
Member

@zliang-akamai zliang-akamai left a comment

Choose a reason for hiding this comment

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

Works well on my end!

Copy link
Contributor

@yec-akamai yec-akamai left a comment

Choose a reason for hiding this comment

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

Works well on my end!

@lgarber-akamai lgarber-akamai merged commit 04c1e92 into linode:dev Sep 16, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement for improvements in existing functionality in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants