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(snippet): fix grammatical error #2557

Merged
merged 1 commit into from
Mar 21, 2024

Conversation

SorkoPiko
Copy link
Contributor

@SorkoPiko SorkoPiko commented Mar 20, 2024

Closes #N/A

📝 Description

Fixes grammatical error in Snippet docs

⛳️ Current behavior (updates)

Snippet docs contains a grammatical error

🚀 New behavior

Snippet docs doesn't contain a grammatical error

💣 Is this a breaking change (Yes/No):

No

📝 Additional Information

N/A

Summary by CodeRabbit

  • Documentation
    • Corrected a typo in the documentation link text from "Tootlip" to "Tooltip" for improved accuracy and consistency.

Copy link

changeset-bot bot commented Mar 20, 2024

⚠️ No Changeset found

Latest commit: 5d4e657

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

Copy link

vercel bot commented Mar 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 20, 2024 8:25pm

Copy link
Contributor

coderabbitai bot commented Mar 20, 2024

Walkthrough

This update focuses on enhancing the textual accuracy within the documentation by correcting a typographical error. The modification specifically targets the misspelled word "Tootlip," changing it to "Tooltip" across the referenced documentation component. This minor yet impactful change ensures consistency and clarity, improving the overall user experience by providing correct and precise information.

Changes

Files Change Summary
.../docs/components/snippet.mdx Corrected typo in link text from "Tootlip" to "Tooltip"

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

vercel bot commented Mar 20, 2024

@SorkoPiko is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

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.

Review Status

Actionable comments generated: 2

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between e67b3af and 5d4e657.
Files selected for processing (1)
  • apps/docs/content/docs/components/snippet.mdx (1 hunks)
Additional comments: 3
apps/docs/content/docs/components/snippet.mdx (3)
  • 59-59: The link text typo correction from "Tootlip" to "Tooltip" enhances the documentation's accuracy and consistency.
  • 56-62: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [81-81]

The unpaired symbol warning near line 81 seems to be a false positive, as the context shows a JSX-like syntax that is correctly formatted.

  • 56-62: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [104-104]

The warning about the unpaired symbol and uppercase character in the classNames prop seems to be a false positive, as this is a code snippet showing a prop type definition.

apps/docs/content/docs/components/snippet.mdx Show resolved Hide resolved
Copy link
Member

@jrgarciadev jrgarciadev left a comment

Choose a reason for hiding this comment

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

Thank you! @SorkoPiko

@jrgarciadev jrgarciadev merged commit 0973cd9 into nextui-org:main Mar 21, 2024
2 of 3 checks passed
@SorkoPiko SorkoPiko deleted the docs/snippet-typo branch March 21, 2024 18:55
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.

None yet

3 participants