Skip to content

docs: fix typos and improve documentation clarity #24978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 24, 2025
Merged

Conversation

anim001k
Copy link
Contributor

@anim001k anim001k commented Jul 23, 2025

Description:
This pull request addresses several minor typos and improves the clarity of documentation across multiple files.

  • Corrects spelling mistakes (e.g., "rouge" → "rogue", "adviced" → "advised", "annote" → "annotate", etc.)
  • Fixes variable and field names (e.g., "reciever" → "receiver", "address" → "addresses")

Summary by CodeRabbit

  • Documentation
    • Corrected multiple typographical errors across various architecture decision records and advanced documentation sections for improved clarity and accuracy.
    • Fixed a misspelled field name in the NFT module documentation to accurately reflect the intended recipient field.
    • No functional or logic changes were made; all updates are editorial.

Copy link
Contributor

coderabbitai bot commented Jul 23, 2025

📝 Walkthrough

Walkthrough

A series of documentation files were updated to correct various typographical errors, including spelling mistakes in prose, comments, and a protobuf message field name. No logic, control flow, or functional code was changed. Only editorial improvements were made to enhance clarity and correctness in the documentation and message definitions.

Changes

Files Change Summary
docs/architecture/adr-006-secret-store-replacement.md Fixed typo: "rouge" → "rogue"
docs/architecture/adr-010-modular-antehandler.md Fixed typo: "retun" → "return" in method example
docs/architecture/adr-028-public-key-addresses.md Fixed typo: "addresse" → "addresses"
docs/architecture/adr-042-group-module.md Fixed typo: "ans" → "and"
docs/architecture/adr-043-nft-module.md Fixed typo in protobuf: "reveiver" → "receiver" in MsgSend field
docs/architecture/adr-059-test-scopes.md Fixed typo: "adviced" → "advised"
docs/docs/learn/advanced/01-transactions.md Fixed typo: "Morever" → "Moreover"
docs/docs/learn/advanced/05-encoding.md Fixed typo: "annote" → "annotate"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

⚡️ Unit Test Generation - Beta

CodeRabbit's unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project's testing patterns. Learn more here, or just try it under ✨ Finishing Touches.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/architecture/adr-028-public-key-addresses.md (1)

322-322: Minor grammar issue – “kept” → “keep”

The verb tense is off. Recommend:

-* we will need to set a pre-image prefix for module addresses to kept them in 32-byte space: `hash(hash('module') + module_key)`
+* we will need to set a pre-image prefix for module addresses to keep them within the 32-byte space: `hash(hash('module') + module_key)`
docs/architecture/adr-059-test-scopes.md (1)

151-151: Sentence reads awkwardly

Swap “will” for “with” to fix grammar:

-The SDK uses an application will only the required modules for the tests.
+The SDK uses an application with only the required modules for the tests.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between d6c085d and 7f56927.

⛔ Files ignored due to path filters (1)
  • types/tx/tx.pb.go is excluded by !**/*.pb.go, !**/*.pb.go
📒 Files selected for processing (8)
  • docs/architecture/adr-006-secret-store-replacement.md (1 hunks)
  • docs/architecture/adr-010-modular-antehandler.md (1 hunks)
  • docs/architecture/adr-028-public-key-addresses.md (1 hunks)
  • docs/architecture/adr-042-group-module.md (1 hunks)
  • docs/architecture/adr-043-nft-module.md (1 hunks)
  • docs/architecture/adr-059-test-scopes.md (1 hunks)
  • docs/docs/learn/advanced/01-transactions.md (1 hunks)
  • docs/docs/learn/advanced/05-encoding.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Summary
🔇 Additional comments (6)
docs/architecture/adr-010-modular-antehandler.md (1)

145-145: Typo correction LGTM

Fixing the misspelled return clarifies the example and eliminates potential copy-paste errors. Nothing else to address here.

docs/architecture/adr-042-group-module.md (1)

25-25: Typo fix looks good

ansand reads correctly.

docs/architecture/adr-006-secret-store-replacement.md (1)

24-24: Spelling correction confirmed

Changing “rouge software” → “rogue software” improves clarity.

docs/docs/learn/advanced/05-encoding.md (1)

60-60: Spelling fix acknowledged

“annote” → “annotate” is correct.

docs/docs/learn/advanced/01-transactions.md (1)

77-80: Typo fix looks good – no further action.

Correcting “Morever” to “Moreover” improves readability and requires no additional changes.

docs/architecture/adr-043-nft-module.md (1)

155-160: Field-name correction acknowledged — please ensure implementation parity.

Renaming reveiverreceiver aligns the ADR with conventional spelling. Double-check that:

  1. The actual MsgSend protobuf definition under proto/ already uses receiver.
  2. Any code samples, tests, or generated clients refer to the updated field.

A quick grep across the repo will confirm there are no lingering misspellings.

@aljo242 aljo242 enabled auto-merge July 24, 2025 14:44
@aljo242 aljo242 added this pull request to the merge queue Jul 24, 2025
Merged via the queue into cosmos:main with commit 161236e Jul 24, 2025
44 of 45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants