Skip to content
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

docs: fix several typos in the document #22052

Merged
merged 1 commit into from
Oct 3, 2024
Merged

docs: fix several typos in the document #22052

merged 1 commit into from
Oct 3, 2024

Conversation

clmyy
Copy link
Contributor

@clmyy clmyy commented Oct 2, 2024

Description

I've found several typos in this document while reviewing it.
The typos are fixed now.

Author Checklist

  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Summary by CodeRabbit

  • Documentation
    • Improved grammatical accuracy and clarity in the NFT module documentation.

@clmyy clmyy requested a review from a team as a code owner October 2, 2024 21:31
Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

📝 Walkthrough

Walkthrough

The pull request involves textual modifications to the document adr-043-nft-module.md. The changes primarily focus on grammatical corrections and clarifications, including proper article usage, capitalization, and hyphenation. These adjustments enhance the document's clarity and correctness while maintaining its original content and functionality.

Changes

File Change Summary
docs/architecture/adr-043-nft-module.md Corrected phrases for grammatical accuracy, including article usage, capitalization, and hyphenation.

Possibly related PRs

  • docs(x/gov): fix typos #21588: This PR focuses on grammatical corrections in documentation, similar to the main PR's emphasis on textual modifications for clarity and correctness.
  • docs: fix typo #21815: This PR addresses typographical errors in documentation, specifically correcting the term "demon" to "denom," aligning with the main PR's goal of enhancing document clarity.
  • docs: fix typo #21835: This PR involves a minor textual modification in the CONTRIBUTING.md file, which is akin to the grammatical corrections made in the main PR.
  • docs: Update More Info link of SECURITY.md #22042: This PR updates documentation links to ensure accuracy, which relates to the main PR's focus on improving the clarity and correctness of the document.

Suggested labels

Type: ADR

Suggested reviewers

  • sontrinh16
  • julienrbrt
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between bf95c81 and 5da4396.

📒 Files selected for processing (1)
  • docs/architecture/adr-043-nft-module.md (5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/adr-043-nft-module.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 LanguageTool
docs/architecture/adr-043-nft-module.md

[uncategorized] ~51-~51: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...ule should not be used as a standalone. Instead an app should create a specialized modu...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)


[uncategorized] ~110-~110: When ‘app-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...inted by uri; optional * data is an app specific data of the NFT. Can be used by composi...

(SPECIFIC_HYPHEN)


[style] ~110-~110: To form a complete sentence, be sure to include a subject.
Context: ...ta` is an app specific data of the NFT. Can be used by composing modules to specify...

(MISSING_IT_THERE)


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 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.

@middthe
Copy link

middthe commented Oct 3, 2024

Based on CONTRIBUTION Note

Note 2: At this time, we will not be accepting contributions that only fix spelling or grammar errors in documentation, code or elsewhere. The repository has a nightly job that spell checks all files and will automatically open PRs for any spelling errors.

I don't think this is worth merging. Also, it's better to check one module docs once-time than modify docs one by one like this PR.

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

thanks!

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Oct 3, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Oct 3, 2024
Merged via the queue into cosmos:main with commit 4e6a43b Oct 3, 2024
71 of 75 checks passed
mergify bot pushed a commit that referenced this pull request Oct 3, 2024
julienrbrt pushed a commit that referenced this pull request Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release Type: ADR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants