Skip to content

Commit

Permalink
docs: fix some comments (#1341)
Browse files Browse the repository at this point in the history
## Description

 fix some comments

<!-- Add a description of the changes that this PR introduces and the
files that
are the most critical to review. -->

---

### 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/desmos-labs/desmos/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building
modules](https://docs.cosmos.network/v0.44/building-modules/intro.html)
- [ ] included the necessary unit and integration
[tests](https://github.com/desmos-labs/desmos/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 is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
  - Corrected typos in comments to enhance clarity.
- Updated documentation to specify conditions for using the `chain_name`
parameter.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: cloudclaim <824973921@qq.com>
  • Loading branch information
cloudclaim committed Jul 15, 2024
1 parent fdd752f commit c7a4db7
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion x/profiles/keeper/alias_functions.go
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ func (k Keeper) IterateDefaultExternalAddresses(ctx sdk.Context, fn func(entry t
}

// GetDefaultExternalAddressEntries returns a slice of DefaultExternalAddressEntry objects containing the details of all the
// default exnternal address entries stored inside the current context
// default external address entries stored inside the current context
func (k Keeper) GetDefaultExternalAddressEntries(ctx sdk.Context) []types.DefaultExternalAddressEntry {
var entries []types.DefaultExternalAddressEntry
k.IterateDefaultExternalAddresses(ctx, func(entry types.DefaultExternalAddressEntry) (stop bool) {
Expand Down
2 changes: 1 addition & 1 deletion x/profiles/keeper/keeper_chain_links.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ func (k Keeper) DeleteChainLink(ctx sdk.Context, link types.ChainLink) {
store.Delete(types.ChainLinksStoreKey(link.User, link.ChainConfig.Name, link.GetAddressData().GetValue()))
store.Delete(types.ChainLinkOwnerKey(link.ChainConfig.Name, link.GetAddressData().GetValue(), link.User))

// Update the default external address to be the oldest link if the deleted link is default exnternal address
// Update the default external address to be the oldest link if the deleted link is default external address
if k.isDefaultExternalAddress(ctx, link) {
k.updateOwnerDefaultExternalAddress(ctx, link.User, link.ChainConfig.Name)
}
Expand Down
2 changes: 1 addition & 1 deletion x/profiles/spec/07-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ desmos query profiles default-external-addresses [[owner]] [[chain_name]] [flags
```

**Notes**
- The `chain_name` paremeter will only be used if the `owner` is specified
- The `chain_name` parameter will only be used if the `owner` is specified

Example:
```bash
Expand Down

0 comments on commit c7a4db7

Please sign in to comment.