docs(modal): fix small typos and add clarifying language #4629
Conversation
🦋 Changeset detectedLatest commit: 2dd10a9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
@millmason is attempting to deploy a commit to the HeroUI Inc Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe pull request contains two changes: an empty changeset file and documentation updates for the Modal component in the docs. The documentation modifications focus on improving clarity, grammar, and readability without changing any functional aspects of the component. The changes include minor textual refinements, sentence structure improvements, and more precise language describing modal interactions and positioning. Changes
No sequence diagram is necessary for these changes, as they are purely textual documentation updates without modifications to code or system interactions. 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/docs/content/docs/components/modal.mdx (1)
Line range hint
87-101: Add missing comma for better readabilityThe changes improve clarity by using more appropriate terminology ("larger" instead of "higher") and better punctuation. However, there's still a missing comma.
Add a comma after "By default":
-By default the modal is centered +By default, the modal is centered
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.changeset/bright-cameras-visit.md(1 hunks)apps/docs/content/docs/components/modal.mdx(6 hunks)
✅ Files skipped from review due to trivial changes (1)
- .changeset/bright-cameras-visit.md
🧰 Additional context used
🪛 LanguageTool
apps/docs/content/docs/components/modal.mdx
[uncategorized] ~86-~86: Did you mean: “By default,”?
Context: ...onDismissable} /> ### Modal placement By default the modal is centered on screens larger...
(BY_DEFAULT_COMMA)
🔇 Additional comments (5)
apps/docs/content/docs/components/modal.mdx (5)
3-3: LGTM! Grammar improvementThe removal of the article "a" before "custom content" improves grammar as "content" is an uncountable noun.
Also applies to: 10-10
67-67: LGTM! Improved clarityAdding "the" before "modal dialog" enhances readability by properly referencing the specific modal being discussed.
81-81: LGTM! Enhanced technical accuracyAdding "property" after "isKeyboardDismissDisabled" provides better clarity about the API.
114-114: LGTM! Proper capitalizationCorrect capitalization of "The" at the beginning of the sentence.
143-143: LGTM! Improved user instructionsThe changes provide:
- More explicit instructions for dragging the modal
- Clearer explanation of the overflow behavior
Also applies to: 149-149
Closes # (N/A)
📝 Description
Adds some clarifying language and corrects typos in the docs for the
Modalcomponent⛳️ Current behavior (updates)
I found some of the descriptions in the documentation a little confusing, so I tested the behavior and then added language that I thought might be more explicit, and cleaned up some typos alongside it.
🚀 New behavior
Hopefully language is more transparent!
💣 Is this a breaking change (Yes/No):
No, not at all
Summary by CodeRabbit