cosmos-sdk/x/bank
Ivan Gavran 9f543b1c3b
refactor: Small clarifications to authz docs and one error description (#11506)
## Description

This small PR is trying to clarify the documentation that I found ambiguous when reading it.
Furthermore, it makes one error message more precise ("non-negative" --> "positive").

In particular:
 - I clarified that the field `AcceptResponse.Accept` will be set to `true` when an authorization is accepted, but **will not** be set to `false` otherwise (instead, the function `Accept` will return an error).
 - I clarified that the field `AcceptResponse.Updated` will not always be populated: it will be `nil` unless there are real changes to the authorization
 - I changed the error message in the `send_authorization.go` function, when `IsAllPositive()` returns `false` from _spend limit cannot be negitive_ to _spend limit must be positive_. I emphasized the fact that spend limit must be positive in the documentation.

This is my first contribution to the Cosmos-SDK codebase so if I made some mistake the process (wrt the checklist), guide me patiently, pls.



---

### 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
- [x] added `!` to the type prefix if API or client breaking change
- [x] 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: NOTE: does not apply, these are clarification changes
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules): NOTE: does not apply, these are clarification changes
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing): NOTE: does not apply, these are clarification changes
- [ ] added a changelog entry to `CHANGELOG.md`: NOTE: does not apply, these are clarification changes
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) NOTE: does not apply, these are clarification changes
- [x] 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)
2022-04-03 09:50:51 +00:00
..
atlas docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
client fix: Update query.go to include pagination for bank q totals (#11355) 2022-03-15 14:43:21 +00:00
exported Index supply by denom (#8517) 2021-03-03 09:58:16 +00:00
keeper feat: add support for spendable balances gRPC query (#11417) 2022-03-25 11:24:58 +01:00
migrations chore: v045 cleanups for changelog and migrations (#10974) 2022-01-20 12:11:16 +01:00
simulation feat: replace all ModuleCdc instances with legacy.Cdc (#11240) 2022-02-23 14:13:36 +00:00
spec docs: Update MultiSend ref to bank/spec/README.md (#11490) 2022-03-29 09:58:02 -04:00
testutil refactor: Move simapp FundAccount and FundModuleAccount to testutil (#9427) 2021-06-29 10:23:13 +00:00
types refactor: Small clarifications to authz docs and one error description (#11506) 2022-04-03 09:50:51 +00:00
README.md docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
app_test.go feat(tests): add simapp setup helpers (#10020) 2021-09-15 17:18:01 -04:00
bench_test.go feat(tests): add simapp setup helpers (#10020) 2021-09-15 17:18:01 -04:00
module.go fix: Check error for RegisterQueryHandlerClient in all modules RegisterGRPCGatewayRoutes (#10439) 2021-10-28 11:01:25 +00:00

README.md

Bank

  • Bank - Token transfer functionalities.