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: improve comments for clarity in module.go, store.go, and memdb.go #23260

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions core/appmodule/v2/module.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ type AppModule interface {
// custom logic before BeginBlock.
type HasPreBlocker interface {
AppModule
// PreBlock is method that will be run before BeginBlock.
// PreBlock is a method that will be run before BeginBlock.
PreBlock(context.Context) error
}

Expand Down Expand Up @@ -85,7 +85,7 @@ type HasTxValidator[T transaction.Tx] interface {
}

// HasUpdateValidators is an extension interface that contains information about the AppModule and UpdateValidators.
// It can be seen as the alternative of the Cosmos SDK' HasABCIEndBlocker.
// It can be seen as the alternative of the Cosmos SDK's HasABCIEndBlocker.
// Both are still supported.
type HasUpdateValidators interface {
AppModule
Expand Down
2 changes: 1 addition & 1 deletion core/store/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ type ReaderMap interface {
// WriterMap represents a writable actor state.
type WriterMap interface {
ReaderMap
// GetWriter must the return a WritableState
// GetWriter must return a WritableState
// for the provided actor namespace.
GetWriter(actor []byte) (Writer, error)
// ApplyStateChanges applies all the state changes
Expand Down
2 changes: 1 addition & 1 deletion core/testing/memdb.go
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@ func (b *memDBBatch) Write() error {
}
}

// Make sure batch cannot be used afterwards. Callers should still call Close(), for
// Make sure batch cannot be used afterwards. Callers should still call Close() for cleanup.
return b.Close()
}

Expand Down
Loading