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(callbacks): improved godocs for ContractKeeper state reversion #4516

Merged
merged 4 commits into from
Aug 31, 2023
Merged

docs(callbacks): improved godocs for ContractKeeper state reversion #4516

merged 4 commits into from
Aug 31, 2023

Conversation

srdtrk
Copy link
Member

@srdtrk srdtrk commented Aug 30, 2023 •
edited
Loading

Description

closes: #4509

Commit Message / Changelog Entry

docs(callbacks): improved godocs for ContractKeeper state reversion

see the guidelines for commit messages. (view raw markdown for examples)

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

@srdtrk srdtrk added docs Improvements or additions to documentation callbacks middleware Issues for callbacks middleware labels Aug 30, 2023
colin-axner
colin-axner approved these changes Aug 31, 2023
View reviewed changes
Copy link
Contributor

@colin-axner colin-axner left a comment

Choose a reason for hiding this comment

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

Thanks @srdtrk!

damiannolan
damiannolan approved these changes Aug 31, 2023
View reviewed changes
Copy link
Contributor

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

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

I guess we're assuming the reader has some level of knowledge of cached context. Possible improvement could be to use:

This entry point is called with a cached context using a branched multi-store.

But I think its fine as is 👍

@srdtrk srdtrk merged commit 7985bbd into main Aug 31, 2023
@srdtrk srdtrk deleted the serdar/issue#4509-contract-keeper-state-godocs branch August 31, 2023 09:52
mergify bot pushed a commit that referenced this pull request Aug 31, 2023
@srdtrk @mergify
docs(callbacks): improved godocs for ContractKeeper state reversion (#…
6a7ceea 
…4516)

* docs(callbacks): improved godocs for ContractKeeper state reversion

* docs: updated docs/callbacks/interfaces.md

(cherry picked from commit 7985bbd)

# Conflicts:
#	modules/apps/callbacks/types/expected_keepers.go
@mergify mergify bot mentioned this pull request Aug 31, 2023
Merged
srdtrk added a commit that referenced this pull request Aug 31, 2023
@mergify @srdtrk
docs(callbacks): improved godocs for ContractKeeper state reversion (…
545539c 
…backport #4516) (#4526)

* docs(callbacks): improved godocs for ContractKeeper state reversion (#4516)

* docs(callbacks): improved godocs for ContractKeeper state reversion

* docs: updated docs/callbacks/interfaces.md

(cherry picked from commit 7985bbd)

# Conflicts:
#	modules/apps/callbacks/types/expected_keepers.go

* fix: resolved backport conflicts

---------

Co-authored-by: srdtrk <59252793+srdtrk@users.noreply.github.com>
Co-authored-by: srdtrk <srdtrk@hotmail.com>
mergify bot pushed a commit that referenced this pull request Aug 31, 2023
@srdtrk @mergify
docs(callbacks): improved godocs for ContractKeeper state reversion (#…
7a368cf 
…4516)

* docs(callbacks): improved godocs for ContractKeeper state reversion

* docs: updated docs/callbacks/interfaces.md

(cherry picked from commit 7985bbd)

# Conflicts:
#	modules/apps/callbacks/types/expected_keepers.go
@mergify mergify bot mentioned this pull request Aug 31, 2023
Merged
crodriguezvega pushed a commit that referenced this pull request Aug 31, 2023
@mergify @srdtrk
docs(callbacks): improved godocs for ContractKeeper state reversion (…
45c051d 
…backport #4516) (#4531)

* docs(callbacks): improved godocs for ContractKeeper state reversion (#4516)

* docs(callbacks): improved godocs for ContractKeeper state reversion

* docs: updated docs/callbacks/interfaces.md

(cherry picked from commit 7985bbd)

# Conflicts:
#	modules/apps/callbacks/types/expected_keepers.go

* fix: resolved backport conflicts

---------

Co-authored-by: srdtrk <59252793+srdtrk@users.noreply.github.com>
Co-authored-by: srdtrk <srdtrk@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@damiannolan damiannolan damiannolan approved these changes

@charleenfei charleenfei charleenfei approved these changes

@colin-axner colin-axner colin-axner approved these changes

@AdityaSripal AdityaSripal Awaiting requested review from AdityaSripal AdityaSripal is a code owner

@crodriguezvega crodriguezvega Awaiting requested review from crodriguezvega

@chatton chatton Awaiting requested review from chatton

@DimitrisJim DimitrisJim Awaiting requested review from DimitrisJim

Assignees
No one assigned
Labels
callbacks middleware Issues for callbacks middleware docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve the godocs for ContractKeeper's state and tx reversal
4 participants
@srdtrk @damiannolan @charleenfei @colin-axner