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

refactor(client/keys): keys show command help message #18939

Merged
merged 2 commits into from
Jan 4, 2024

Conversation

hattizai
Copy link
Contributor

@hattizai hattizai commented Jan 4, 2024

Description

As the code in show.go shows, I think we should change the flag help message of --address and --pubkey and --device

  1. --address and --pubkey don't override the --output, but mutually exclusive
  2. --device and --pubkey are also mutually exclusive
if isOutputSet && (isShowAddr || isShowPubKey) {
	return errors.New("cannot use --output with --address or --pubkey")
}
if isShowDevice {
	if isShowPubKey {
		return errors.New("the device flag (-d) can only be used for addresses not pubkeys")
	}
	...
}

@hattizai hattizai requested a review from a team as a code owner January 4, 2024 05:19
Copy link
Contributor

coderabbitai bot commented Jan 4, 2024

Walkthrough

The recent update includes revisions to the command-line interface, specifically improving the clarity of flag descriptions for a key display operation. The modifications aim to enhance user understanding of the flags' functions and any limitations they might carry.

Changes

File(s) Summary of Changes
client/keys/show.go Updated descriptions for --output, --pubkey, and --address flags to enhance clarity on their usage and restrictions.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit's AI:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
    • @coderabbitai read the files in the src/scheduler package and generate README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added C:CLI C:Keys Keybase, KMS and HSMs labels Jan 4, 2024
@hattizai hattizai changed the title refactor(keys): keys show command help message refactor(keys): fix keys show command flag help message Jan 4, 2024
@coderabbitai coderabbitai bot changed the title refactor(keys): fix keys show command flag help message refactor(keys): keys show command help message Jan 4, 2024
@hattizai hattizai changed the title refactor(keys): keys show command help message refactor(client/keys): keys show command help message Jan 4, 2024
@alexanderbez alexanderbez added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Jan 4, 2024
@alexanderbez alexanderbez enabled auto-merge January 4, 2024 17:16
@alexanderbez alexanderbez added this pull request to the merge queue Jan 4, 2024
Merged via the queue into cosmos:main with commit 7fbca40 Jan 4, 2024
54 of 56 checks passed
mergify bot pushed a commit that referenced this pull request Jan 4, 2024
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
(cherry picked from commit 7fbca40)
@hattizai hattizai deleted the chore/keys-show branch January 6, 2024 03:26
tac0turtle pushed a commit that referenced this pull request Jan 6, 2024
) (#18947)

Co-authored-by: hattizai <150505746+hattizai@users.noreply.github.com>
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:CLI C:Keys Keybase, KMS and HSMs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants