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: Amend usage of sdk.Context #17239

Merged
merged 3 commits into from
Aug 4, 2023
Merged

docs: Amend usage of sdk.Context #17239

merged 3 commits into from
Aug 4, 2023

Conversation

samricotta
Copy link
Contributor

@samricotta samricotta commented Aug 1, 2023

Description

Part of: #17207

Amends the usage of sdk.Context to context.Context within keeper docs


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)

@samricotta samricotta requested a review from a team as a code owner August 1, 2023 09:27
@samricotta samricotta added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Aug 1, 2023
@samricotta samricotta changed the title Docs: Amend usage of sdk.Context docs: Amend usage of sdk.Context Aug 1, 2023
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.

There are a few missing: ex:

package appmodule
/
* `InitGenesis(sdk.Context, codec.JSONCodec, json.RawMessage)`: Initializes the subset of the state managed by the module. It is called at genesis (i.e. when the chain is first started).

image
There are some expected one in here, but a good chunk of them should be updated.

(Sorry if you weren't done with the PR, but it was open :D)

@samricotta
Copy link
Contributor Author

All good! This was just for the keeper docs for now bc there are a few more instances of sdk.Context I wanted to double check before changing in the docs but maybe I can just do all instances here

@samricotta samricotta marked this pull request as draft August 1, 2023 12:46
@itsdevbear
Copy link
Contributor

☃️

@samricotta samricotta marked this pull request as ready for review August 4, 2023 13:23
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.

lgtm!

@julienrbrt julienrbrt added this pull request to the merge queue Aug 4, 2023
Merged via the queue into main with commit 213ddf7 Aug 4, 2023
42 checks passed
@julienrbrt julienrbrt deleted the sam/keeper-docs-update branch August 4, 2023 17:23
mergify bot pushed a commit that referenced this pull request Aug 4, 2023
julienrbrt pushed a commit that referenced this pull request Aug 4, 2023
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
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
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants