Remove error argument from WrapServiceResult API #11039
Assignees
Labels
T:Docs
Changes and features related to documentation.
Comments
julienrbrt
added
Type: Question
T:Docs
|
Hey @colin-axner, The reason is so that you don't have to do an error checking for each RPC response ( e.g. https://github.com/CosmWasm/wasmd/blob/main/x/wasm/handler.go#L46 I will update the docs to make that clearer! |
19 tasks
19 tasks
mergify bot
pushed a commit
that referenced
this issue
Apr 24, 2022
## 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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary
The
WrapServiceResultfunction starts by checking the error argument to see if it is not nil and then immediately returns. This is very unconventional. Based on a quick grep, the only time this function is used also does this check before callingWrapServiceResult. If the error argument is unused, it should be removed, explicitly requiring the caller to check the error before callingWrapServiceResultProblem Definition
The error argument is unused and the go doc doesn't explain this design decision
Proposal
Update the API or explain the reasoning in the godoc. Maybe this is intended for future usage?
For Admin Use
The text was updated successfully, but these errors were encountered: