Skip to content

chore(tailwind-preset): fix typos in uiVariants.md#1727

Merged
colinaaa merged 1 commit intomainfrom
chore/Dugyu-fix-typo
Sep 11, 2025
Merged

chore(tailwind-preset): fix typos in uiVariants.md#1727
colinaaa merged 1 commit intomainfrom
chore/Dugyu-fix-typo

Conversation

@Dugyu
Copy link
Copy Markdown
Collaborator

@Dugyu Dugyu commented Sep 11, 2025

Summary by CodeRabbit

  • Documentation
    • Updated variant selector examples to use "ui-open:*" (removed leading dot) for accuracy.
    • Clarified wording in the “Enable with Default Values” section (“prefixes” → “prefix”).
    • Improved formatting in “Customize Prefixes and Values,” applying code styling to data-* patterns.
    • General copy and style refinements for clarity and consistency.

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).
  • Changeset added, and when a BREAKING CHANGE occurs, it needs to be clearly marked (or not required).

Signed-off-by: Guangyu Du <23237626+Dugyu@users.noreply.github.com>
@Dugyu Dugyu requested a review from gaoachao September 11, 2025 11:58
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Sep 11, 2025

⚠️ No Changeset found

Latest commit: 3c5fe48

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 11, 2025

📝 Walkthrough

Walkthrough

Updates a single documentation file to correct a variant selector example, adjust singular wording, and apply minor formatting changes. No code or API changes.

Changes

Cohort / File(s) Summary
Docs: Tailwind preset plugin docs
packages/third-party/tailwind-preset/docs/plugins/lynx-ui/uiVariants.md
Replace selector example from ".ui-open:*" to "ui-open:*" (remove leading dot); change “prefixes” to “prefix”; format data-* patterns with code styling; no functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • gaoachao
  • fzx2666-fz

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title concisely and accurately summarizes the primary change: fixing typos in uiVariants.md within the tailwind-preset package. It is a short, single sentence that directly reflects the documentation-only changes in the changeset and avoids unnecessary detail or noise. A reviewer scanning history will understand the main intent from this title.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Poem

A nibble of docs, a hop and a spin,
I trimmed a dot off the variant’s skin.
One prefix to rule it—clean and neat,
Backticks on data-* make it complete.
Thump-thump! says the rabbit, “Ship it, sweet!” 🐇✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/Dugyu-fix-typo

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
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)
packages/third-party/tailwind-preset/docs/plugins/lynx-ui/uiVariants.md (2)

7-7: Clarify variant syntax: prefer ui-open: over ui-open:*.

Avoid implying a wildcard. Match the later examples by showing an actual utility.

-...instead of `[data-state="open"]`, you can write `ui-open:*`.
+...instead of `[data-state="open"]`, you can use the variant `ui-open:` (e.g., `ui-open:bg-blue-500`).

25-25: Minor wording tweak for precision.

“patterns” is a bit vague; “attributes” is clearer in this context.

-Use a custom mapping to align with your component state structure (e.g., `data-*` patterns):
+Use a custom mapping to align with your component state structure (e.g., `data-*` attributes):
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2800dce and 3c5fe48.

📒 Files selected for processing (1)
  • packages/third-party/tailwind-preset/docs/plugins/lynx-ui/uiVariants.md (2 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: zizmor
🔇 Additional comments (1)
packages/third-party/tailwind-preset/docs/plugins/lynx-ui/uiVariants.md (1)

13-13: Wording LGTM.

Singular “prefix” is correct here and reads clearly.

@colinaaa colinaaa merged commit a223a13 into main Sep 11, 2025
6 checks passed
@colinaaa colinaaa deleted the chore/Dugyu-fix-typo branch September 11, 2025 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants