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(x/accounts): improve comments (backport #22339) #22342

Merged
merged 3 commits into from
Oct 23, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 23, 2024

Description

Noticed while doing the workshop: https://github.com/julienrbrt/workshop-cosmos-sdk-cosmoverse-2024


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, you can find examples of the prefixes below:

  • confirmed ! in 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

  • reviewed "Files changed" and left comments if necessary

  • included the necessary unit and integration tests

  • added a changelog entry to CHANGELOG.md

  • updated the relevant documentation or specification, including comments for documenting Go code

  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Introduced new message types for multisig account initialization and proposal management.
    • Added functionality for querying multisig account configurations and proposals.
  • Documentation

    • Enhanced comments for clarity in lockup and multisig message definitions.
    • Updated README to provide comprehensive guidance on account functionalities and implementations.
    • Improved structure and readability of the lockup account tutorial.
  • Bug Fixes

    • Improved comment clarity in existing messages without altering functionality.
  • Configuration Updates

    • Updated telemetry server address from localhost:1318 to localhost:1327 in configuration files.

This is an automatic backport of pull request #22339 done by [Mergify](https://mergify.com).

(cherry picked from commit 98be2b8)

# Conflicts:
#	api/cosmos/accounts/defaults/lockup/v1/tx.pulsar.go
#	api/cosmos/accounts/defaults/multisig/v1/multisig.pulsar.go
#	server/v2/api/telemetry/config.go
#	simapp/go.mod
@mergify mergify bot requested a review from a team as a code owner October 23, 2024 10:39
@mergify mergify bot added the conflicts label Oct 23, 2024
Copy link
Contributor Author

mergify bot commented Oct 23, 2024

Cherry-pick of 98be2b8 has failed:

On branch mergify/bp/release/v0.52.x/pr-22339
Your branch is up to date with 'origin/release/v0.52.x'.

You are currently cherry-picking commit 98be2b855.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   tools/confix/data/v2-app.toml
	modified:   x/accounts/README.md
	modified:   x/accounts/defaults/lockup/TUTORIAL.md
	modified:   x/accounts/defaults/lockup/v1/tx.pb.go
	modified:   x/accounts/defaults/multisig/v1/multisig.pb.go
	modified:   x/accounts/proto/cosmos/accounts/defaults/lockup/v1/tx.proto
	modified:   x/accounts/proto/cosmos/accounts/defaults/multisig/v1/multisig.proto

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   api/cosmos/accounts/defaults/lockup/v1/tx.pulsar.go
	deleted by us:   api/cosmos/accounts/defaults/multisig/v1/multisig.pulsar.go
	deleted by us:   server/v2/api/telemetry/config.go
	both modified:   simapp/go.mod

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@github-actions github-actions bot removed C:server/v2 Issues related to server/v2 C:server/v2 api labels Oct 23, 2024
@julienrbrt julienrbrt merged commit 3bb6b60 into release/v0.52.x Oct 23, 2024
69 of 71 checks passed
@julienrbrt julienrbrt deleted the mergify/bp/release/v0.52.x/pr-22339 branch October 23, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant