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

docs: adding additional info on amino.encoding proto annotations #18274

Merged
merged 2 commits into from
Oct 26, 2023

Conversation

damiannolan
Copy link
Contributor

@damiannolan damiannolan commented Oct 26, 2023

Description

Adding some additional info on amino.encoding proto annotations.

Added an additional link to where the encoder is instantiated within tx/signing/aminojson

Closes: #XXXX (nothing)


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

  • Documentation: Clarified the use of the Encoding field in our documentation. This update provides a better understanding of how to encode certain fields, specifically highlighting the legacy_coins option for encoding a null slice of cosmos.base.v1beta1.Coin. This will help users to correctly utilize our system and avoid potential errors.

@damiannolan damiannolan requested a review from a team as a code owner October 26, 2023 13:18
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 26, 2023

Walkthrough

The change provides a valuable clarification in the documentation about the Encoding field. It specifically details how the amino JSON marshaler uses this field to encode certain types, with a focus on the legacy_coins option for encoding a null slice of cosmos.base.v1beta1.Coin.

Changes

File Summary
.../05-protobuf-annotations.md The diff introduces a clarification in the documentation regarding the Encoding field. It explains that the Encoding field instructs the amino JSON marshaler on how to encode certain fields, specifically mentioning the legacy_coins option for encoding a null slice of cosmos.base.v1beta1.Coin.

🐇

In the realm of code, where logic is king,

A small change can make the bells of clarity ring.

With Encoding field's mystery unfurled,

We've made sense of this digital world. 🌍💻


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

Copy link
Member

@tac0turtle tac0turtle 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

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 a755fef and 4daff55.
Files selected for processing (1)
  • docs/build/building-modules/05-protobuf-annotations.md (1} hunks)
Files skipped from review due to trivial changes (1)
  • docs/build/building-modules/05-protobuf-annotations.md

@github-prbot github-prbot requested review from a team, facundomedica and atheeshp and removed request for a team October 26, 2023 13:21
@tac0turtle tac0turtle added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Oct 26, 2023
@tac0turtle tac0turtle added this pull request to the merge queue Oct 26, 2023
Merged via the queue into main with commit 433203f Oct 26, 2023
51 of 52 checks passed
@tac0turtle tac0turtle deleted the damian/amino-encoding-docs branch October 26, 2023 13:56
mergify bot pushed a commit that referenced this pull request Oct 26, 2023
tac0turtle pushed a commit that referenced this pull request Oct 26, 2023
…ackport #18274) (#18275)

Co-authored-by: Damian Nolan <damiannolan@gmail.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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants