From a8b3602c23c629c5bac3d58ff36e1810a8908d38 Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Sun, 24 Apr 2022 22:53:56 +0200 Subject: [PATCH] docs: improve godoc WrapServiceResult (#11736) ## Description Closes: #11039 --- ### 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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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) --- types/result.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/result.go b/types/result.go index 38787e8eb5..29b607a298 100644 --- a/types/result.go +++ b/types/result.go @@ -230,8 +230,8 @@ func (r TxResponse) GetTx() Tx { return nil } -// WrapServiceResult wraps a result from a protobuf RPC service method call in -// a Result object or error. This method takes care of marshaling the res param to +// WrapServiceResult wraps a result from a protobuf RPC service method call (res proto.Message, err error) +// in a Result object or error. This method takes care of marshaling the res param to // protobuf and attaching any events on the ctx.EventManager() to the Result. func WrapServiceResult(ctx Context, res proto.Message, err error) (*Result, error) { if err != nil {