docs: fixed typos and improved clarity in documentation #23077

bouchmann · 2024-12-24T20:03:12Z

corrected typos:
u32 is an uint32 - u32 is a uint32
feeGrater - feeGranter
Appmanager - App Manager
english - English

Summary by CodeRabbit

Bug Fixes
- Corrected article usage in comment for u32 field in MsgRequest.
- Fixed typo in variable name from feeGrater to feeGranter in txParamsFromFlagSet function.
- Updated comment formatting for "Appmanager" to "App Manager" in documentation.
- Corrected capitalization of "english" to "English" in comment for Language type.

coderabbitai · 2024-12-24T20:03:20Z

📝 Walkthrough

Walkthrough

This pull request encompasses minor corrections across multiple files, focusing on improving documentation and fixing typographical errors. The changes include correcting an article in a proto file comment, fixing a variable name typo in a transaction-related function, updating a documentation comment's formatting, and correcting capitalization in a comment. These modifications do not alter the functional behavior of the code but enhance its readability and precision.

Changes

File	Change Summary
`client/v2/internal/testpb/msg.proto`	Corrected comment article from "an uint32" to "a uint32"
`client/v2/tx/types.go`	Fixed variable name from `feeGrater` to `feeGranter` in `txParamsFromFlagSet` function
`core/server/doc.go`	Updated comment formatting from "Appmanager" to "App Manager"
`crypto/keyring/types.go`	Capitalized "english" to "English" in a comment

Possibly related PRs

docs(x/gov): fix typos #21588: Fixing typos in documentation
chore: fix spelling errors #21610: Minor comment corrections in code
chore(x): fix some typos in comment #22508: Addressing typographical errors in comments
chore: fix some function names in comment #23008: Modifying comments to reflect accurate function names
docs: fix typos in documentation files #23063: Fixing typographical errors in documentation files

Suggested labels

C:CLI, C:x/auth, C:server/v2, C:server/v2 api

Suggested reviewers

sontrinh16
julienrbrt
akhilkumarpilli
facundomedica

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ef2f8d and bb2de69.

⛔ Files ignored due to path filters (1)

client/grpc/reflection/reflection.pb.go is excluded by !**/*.pb.go

📒 Files selected for processing (4)

client/v2/internal/testpb/msg.proto (1 hunks)
client/v2/tx/types.go (1 hunks)
core/server/doc.go (1 hunks)
crypto/keyring/types.go (1 hunks)

✅ Files skipped from review due to trivial changes (3)

core/server/doc.go
client/v2/internal/testpb/msg.proto
crypto/keyring/types.go

🧰 Additional context used

📓 Path-based instructions (1)

client/v2/tx/types.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

🔇 Additional comments (2)

client/v2/tx/types.go (2)

184-184: Correct the previously misspelled variable name

The variable name is now updated from "feeGrater" to "feeGranter," which aligns with its intended usage in the fee configuration.

192-192: Fix ensures consistency and correctness

Using the corrected variable name "feeGranter" when calling NewFeeConfig ensures that the fee granter account is passed properly, maintaining overall consistency in the fee logic.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

julienrbrt · 2024-12-28T21:35:57Z

@Mergifyio backport release/v0.52.x

mergify · 2024-12-28T21:36:02Z

backport release/v0.52.x

✅ Backports have been created

#23111 docs: fixed typos and improved clarity in documentation (backport #23077) has been created for branch release/v0.52.x but encountered conflicts

(cherry picked from commit ef7dbc9) # Conflicts: # core/server/doc.go

…port #23077) (#23111) Co-authored-by: Bob <158583129+bouchmann@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr>

bouchmann added 5 commits December 24, 2024 19:58

Update reflection.pb.go

0035886

Update msg.proto

04f4ff1

Update types.go

458273b

Update doc.go

5311cc9

Update types.go

bb2de69

bouchmann requested review from JulianToledano, raynaudoe, a team and julienrbrt as code owners December 24, 2024 20:03

github-actions bot added the C:CLI label Dec 24, 2024

tac0turtle approved these changes Dec 25, 2024

View reviewed changes

JulianToledano approved these changes Dec 26, 2024

View reviewed changes

tac0turtle enabled auto-merge December 27, 2024 14:01

tac0turtle added this pull request to the merge queue Dec 27, 2024

Merged via the queue into cosmos:main with commit ef7dbc9 Dec 27, 2024
66 of 77 checks passed

This was referenced Dec 27, 2024

docs: improve documentation templates and quality assurance checklist #23104

Open

docs: fix typos #23105

Merged

docs: Fix typo in x/slashing/README.md #23107

Merged

julienrbrt changed the title ~~Fixed typos and improved clarity in documentation~~ docs: fixed typos and improved clarity in documentation Dec 28, 2024

mergify bot pushed a commit that referenced this pull request Dec 28, 2024

Fixed typos and improved clarity in documentation (#23077)

d2fb964

(cherry picked from commit ef7dbc9) # Conflicts: # core/server/doc.go

mergify bot mentioned this pull request Dec 28, 2024

docs: fixed typos and improved clarity in documentation (partial backport #23077) #23111

Merged

This was referenced Dec 30, 2024

chore: fix struct field name and some typos in comment #23126

Open

chore: fix comment #23138

Open

docs: fix multiple typos #23143

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fixed typos and improved clarity in documentation #23077

docs: fixed typos and improved clarity in documentation #23077

bouchmann commented Dec 24, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 24, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

julienrbrt commented Dec 28, 2024

mergify bot commented Dec 28, 2024 •

edited

Loading

docs: fixed typos and improved clarity in documentation #23077

docs: fixed typos and improved clarity in documentation #23077

Conversation

bouchmann commented Dec 24, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Dec 24, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

julienrbrt commented Dec 28, 2024

mergify bot commented Dec 28, 2024 • edited Loading

✅ Backports have been created

bouchmann commented Dec 24, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 24, 2024 •

edited

Loading

mergify bot commented Dec 28, 2024 •

edited

Loading