docs: x/gov state machine inline comments changes (#11498)
## Description ref: #11086 --- ### 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... - [ ] 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 - [ ] 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)
This commit is contained in:
parent
90f61870e6
commit
4159d1a9d0
|
@ -109,8 +109,8 @@ func (keeper Keeper) IterateDeposits(ctx sdk.Context, proposalID uint64, cb func
|
|||
}
|
||||
}
|
||||
|
||||
// AddDeposit adds or updates a deposit of a specific depositor on a specific proposal
|
||||
// Activates voting period when appropriate
|
||||
// AddDeposit adds or updates a deposit of a specific depositor on a specific proposal.
|
||||
// Activates voting period when appropriate and returns true in that case, else returns false.
|
||||
func (keeper Keeper) AddDeposit(ctx sdk.Context, proposalID uint64, depositorAddr sdk.AccAddress, depositAmount sdk.Coins) (bool, error) {
|
||||
// Checks to see if proposal exists
|
||||
proposal, ok := keeper.GetProposal(ctx, proposalID)
|
||||
|
|
|
@ -184,7 +184,7 @@ func (q Keeper) Params(c context.Context, req *v1.QueryParamsRequest) (*v1.Query
|
|||
}
|
||||
}
|
||||
|
||||
// Deposit queries single deposit information based proposalID, depositAddr
|
||||
// Deposit queries single deposit information based on proposalID, depositAddr.
|
||||
func (q Keeper) Deposit(c context.Context, req *v1.QueryDepositRequest) (*v1.QueryDepositResponse, error) {
|
||||
if req == nil {
|
||||
return nil, status.Error(codes.InvalidArgument, "invalid request")
|
||||
|
|
|
@ -33,7 +33,7 @@ type Keeper struct {
|
|||
// The (unexposed) keys used to access the stores from the Context.
|
||||
storeKey storetypes.StoreKey
|
||||
|
||||
// The codec codec for binary encoding/decoding.
|
||||
// The codec for binary encoding/decoding.
|
||||
cdc codec.BinaryCodec
|
||||
|
||||
// Legacy Proposal router
|
||||
|
|
Loading…
Reference in New Issue