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.

Sign up for GitHub

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

Jump to bottom

docs: Add k/v docs in structs using collections #17609

Merged
merged 5 commits into from
Sep 4, 2023
Merged

docs: Add k/v docs in structs using collections #17609

merged 5 commits into from
Sep 4, 2023

Conversation

likhita-809
Copy link
Contributor

Description

Closes: #17588

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)

julienrbrt
julienrbrt reviewed Sep 1, 2023
View reviewed changes
x/slashing/keeper/keeper.go Outdated
@@ -29,8 +29,8 @@ type Keeper struct {
Schema collections.Schema
Params collections.Item[types.Params]
ValidatorSigningInfo collections.Map[sdk.ConsAddress, types.ValidatorSigningInfo]
AddrPubkeyRelation collections.Map[[]byte, cryptotypes.PubKey]
ValidatorMissedBlockBitmap collections.Map[collections.Pair[[]byte, uint64], []byte]
AddrPubkeyRelation collections.Map[[]byte, cryptotypes.PubKey] // key: PubKey address | value: PubKey
Copy link
Member

Choose a reason for hiding this comment

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

I haven't verified, but should the comments be in the form:
// AddrPubkeyRelation key: PubKey address | value: PubKey above the field, to show properly and to look better?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could do that, but I elaborated some of them for better understanding

Copy link
Member

Choose a reason for hiding this comment

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

I actually meant above the field, like

// AddrPubkeyRelation lorem ipseum
AddrPubkeyRelation         collections.Map[[]byte, cryptotypes.PubKey]

@likhita-809 likhita-809 changed the title add k/v docs in structs using collections docs: Add k/v docs in structs using collections Sep 1, 2023
@likhita-809 likhita-809 marked this pull request as ready for review September 1, 2023 16:15
@likhita-809 likhita-809 requested a review from a team as a code owner September 1, 2023 16:16
@julienrbrt
Copy link
Member

julienrbrt commented Sep 1, 2023 •
edited
Loading

I believe there are more modules using collections than only staking and slashing. Can we be exhaustive in this PR and do them all?

julienrbrt
julienrbrt reviewed Sep 2, 2023
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Nice! This is indeed super useful.

samricotta
samricotta approved these changes Sep 4, 2023
View reviewed changes
Copy link
Contributor

@samricotta samricotta left a comment

Choose a reason for hiding this comment

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

!!! nice

@julienrbrt julienrbrt added this pull request to the merge queue Sep 4, 2023
Merged via the queue into main with commit 9766142 Sep 4, 2023
51 checks passed
@julienrbrt julienrbrt deleted the likhita/kv-docs branch September 4, 2023 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle approved these changes

@julienrbrt julienrbrt julienrbrt approved these changes

@samricotta samricotta samricotta approved these changes

@testinginprod testinginprod testinginprod approved these changes

Assignees

@facundomedica facundomedica

@testinginprod testinginprod

Labels
C:x/auth C:x/distribution distribution module related C:x/evidence C:x/feegrant C:x/gov C:x/slashing C:x/staking
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document k/v in structs using collections
6 participants
@likhita-809 @julienrbrt @tac0turtle @samricotta @testinginprod @facundomedica