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

docs: update docs #22812

Closed
wants to merge 1 commit into from
Closed

docs: update docs #22812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 3 additions & 5 deletions server/util_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,11 +260,9 @@ func TestInterceptConfigsPreRunHandlerReadsEnvVars(t *testing.T) {
}
}

/*
The following tests are here to check the precedence of each
of the configuration sources. A common setup functionality is used
to avoid duplication of code between tests.
*/
// The following tests are here to check the precedence of each
// of the configuration sources. A common setup functionality is used
// to avoid duplication of code between tests.

var (
TestAddrExpected = "tcp://127.126.125.124:12345" // expected to be used in test
Expand Down
12 changes: 4 additions & 8 deletions store/internal/proofs/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ var (
ErrEmptyKeyInData = errors.New("data contains empty key")
)

/*
CreateMembershipProof will produce a CommitmentProof that the given key (and queries value) exists in the map.
If the key doesn't exist in the tree, this will return an error.
*/
// CreateMembershipProof will produce a CommitmentProof that the given key (and queries value) exists in the map.
// If the key doesn't exist in the tree, this will return an error.
func CreateMembershipProof(data map[string][]byte, key []byte) (*ics23.CommitmentProof, error) {
if len(key) == 0 {
return nil, ErrEmptyKey
Expand All @@ -34,10 +32,8 @@ func CreateMembershipProof(data map[string][]byte, key []byte) (*ics23.Commitmen
return proof, nil
}

/*
CreateNonMembershipProof will produce a CommitmentProof that the given key doesn't exist in the map.
If the key exists in the tree, this will return an error.
*/
// CreateNonMembershipProof will produce a CommitmentProof that the given key doesn't exist in the map.
// If the key exists in the tree, this will return an error.
func CreateNonMembershipProof(data map[string][]byte, key []byte) (*ics23.CommitmentProof, error) {
if len(key) == 0 {
return nil, ErrEmptyKey
Expand Down
14 changes: 6 additions & 8 deletions types/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,12 @@ const (
ExecModeFinalize
)

/*
Context is an immutable object contains all information needed to
process a request.

It contains a context.Context object inside if you want to use that,
but please do not over-use it. We try to keep all data structured
and standard additions here would be better just to add to the Context struct
*/
// Context is an immutable object contains all information needed to
// process a request.
//
// It contains a context.Context object inside if you want to use that,
// but please do not over-use it. We try to keep all data structured
// and standard additions here would be better just to add to the Context struct
type Context struct {
baseCtx context.Context
ms storetypes.MultiStore
Expand Down
Loading