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

chore: sort debug codec cmd outputs and use std long help #18231

Merged
merged 5 commits into from
Oct 24, 2023

Conversation

damiannolan
Copy link
Contributor

@damiannolan damiannolan commented Oct 24, 2023

Description

Follow up from #18219 yesterday.

  • Sort outputs alphabetically
  • Add the std long help with example

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • New Feature: Enhanced the "list-interfaces" and "list-implementations" commands with illustrative examples, making it easier for users to understand their usage.
  • Improvement: Updated examples for the "pubkey", "pubkey-raw", and "raw-bytes" commands, providing clearer guidance for users.
  • Under the Hood: Integrated the "slices" package to improve the functionality of the debug tool, although this change is not directly visible to end-users.

These updates aim to make the debug tool more user-friendly and intuitive, especially for new users.

@damiannolan damiannolan requested a review from a team as a code owner October 24, 2023 08:32
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 24, 2023

Walkthrough

The changes primarily revolve around enhancing the usability of the debug tool. This includes the addition of import statements, examples for commands, and updates to existing examples. The changes aim to improve the user experience and provide clearer guidance on how to use the tool.

Changes

File Summary
client/debug/main.go - Added import statement for the "slices" package.
- Added examples to the "list-interfaces" and "list-implementations" commands.
- Updated examples in the "pubkey", "pubkey-raw", and "raw-bytes" commands.

🐇

In the land of code, where the debuggers play,

Changes were made, to brighten the day.

Examples were added, imports were too,

Making things clearer, for me and for you. 🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.json

@github-actions github-actions bot added the C:CLI label Oct 24, 2023
@github-prbot github-prbot requested review from a team, facundomedica and likhita-809 and removed request for a team October 24, 2023 08:32
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 458dd04 and 974e7a8.
Files selected for processing (1)
  • client/debug/main.go (3 hunks)
Files skipped from review due to trivial changes (1)
  • client/debug/main.go

client/debug/main.go Outdated Show resolved Hide resolved
client/debug/main.go Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 974e7a8 and 629cb69.
Files selected for processing (1)
  • client/debug/main.go (6 hunks)
Files skipped from review due to trivial changes (1)
  • client/debug/main.go

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 629cb69 and ff45bac.
Files selected for processing (1)
  • client/debug/main.go (6 hunks)
Files skipped from review due to trivial changes (1)
  • client/debug/main.go

@damiannolan
Copy link
Contributor Author

Looks good now! 👍 Changed the pubkey cmd helpers to also use the example field correctly.

Thanks for the quick reviews @julienrbrt @likhita-809 ❤️

@julienrbrt julienrbrt enabled auto-merge October 24, 2023 09:06
@julienrbrt julienrbrt added this pull request to the merge queue Oct 24, 2023
Merged via the queue into main with commit 39c9641 Oct 24, 2023
55 checks passed
@julienrbrt julienrbrt deleted the damian/add-codec-debug-cmd branch October 24, 2023 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants