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

fix(docs): typo in selectorIcon for date and date range pickers #5013

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from

Conversation

obiwac
Copy link

@obiwac obiwac commented Mar 10, 2025

📝 Description

Small typo in the docs. selector instead of selectorIcon:

image

⛳️ Current behavior (updates)

Not a behavioural change.

🚀 New behavior

Not a behavioural change.

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

No.

📝 Additional Information

None.

Summary by CodeRabbit

  • Documentation
    • Revised the DatePicker documentation to use "selectorIcon" instead of "selector" for clearer property description.
    • Revised the DateRangePicker documentation to reflect the "selectorIcon" terminology, ensuring consistent property naming.

@obiwac obiwac requested a review from jrgarciadev as a code owner March 10, 2025 10:30
Copy link

changeset-bot bot commented Mar 10, 2025

⚠️ No Changeset found

Latest commit: 42ac20c

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 10, 2025

@obiwac is attempting to deploy a commit to the HeroUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Mar 10, 2025

Walkthrough

This pull request updates the documentation for two components by replacing the term selector with selectorIcon in both the DatePicker and DateRangePicker component documentation. The change ensures that the terminology aligns with the property names used in the codebase while leaving the functionality unchanged.

Changes

File(s) Change Summary
apps/docs/content/docs/components/date-picker.mdx, apps/docs/content/docs/components/date-range-picker.mdx Renamed the term from selector to selectorIcon in the documentation for both DatePicker and DateRangePicker components for clarity.

Suggested labels

📋 Scope : Docs

Suggested reviewers

  • wingkwong
  • jrgarciadev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 03ee057 and 42ac20c.

📒 Files selected for processing (2)
  • apps/docs/content/docs/components/date-picker.mdx (1 hunks)
  • apps/docs/content/docs/components/date-range-picker.mdx (1 hunks)
🔇 Additional comments (2)
apps/docs/content/docs/components/date-range-picker.mdx (1)

119-119:

✅ Verification successful

Typo Correction in Selector Prop Name

According to the PR objectives, the term currently shown as selectorIcon is a typographical error and must be replaced with selector to correctly reflect the intended property name.

Please update this line as follows:

-You can use the `selectorIcon` to add content to the start and end of the date-range-picker.
+You can use the `selector` to add content to the start and end of the date-range-picker.

Based on the verification results, the file indeed contains the term selectorIcon at line 119. Per the PR objectives, this is a typographical error, and the property should correctly be named selector.

Action Required: Update the documentation

  • Update line 119 in apps/docs/content/docs/components/date-range-picker.mdx from:
    -You can use the `selectorIcon` to add content to the start and end of the date-range-picker.
    +You can use the `selector` to add content to the start and end of the date-range-picker.

🏁 Script executed:

#!/bin/bash
# Check if the file uses the incorrect property name "selectorIcon" at the expected location.
rg "selectorIcon" apps/docs/content/docs/components/date-range-picker.mdx

Length of output: 678


Typo Correction in Selector Prop Name

The property name currently shown as selectorIcon is a typographical error that must be corrected to selector according to the PR objectives. The file
apps/docs/content/docs/components/date-range-picker.mdx
includes multiple instances of the incorrect name. Please update the following:

  • Documentation Text (line 119):

    -You can use the `selectorIcon` to add content to the start and end of the date-range-picker.
    +You can use the `selector` to add content to the start and end of the date-range-picker.
  • Component Demo:
    Update <CodeDemo title="Selector Icon" files={dateRangePickerContent.selectorIcon} /> to use the correct property name. For example, change the title from “Selector Icon” to “Selector” and revise the file reference from dateRangePickerContent.selectorIcon to dateRangePickerContent.selector.

  • Prop Documentation:
    Wherever the prop is described (e.g., in the API or type definition sections), replace occurrences such as:

    - **selectorIcon**: Selector icon element.
    -      attribute: "selectorIcon",
    + **selector**: Selector element.
    +      attribute: "selector",

Ensure all references in this file align with the intended naming.

apps/docs/content/docs/components/date-picker.mdx (1)

96-96:

✅ Verification successful

Typo Correction in Selector Prop Name

The documentation is currently using selectorIcon; however, per the PR objectives, this is a typo and should be corrected to selector.

Please update the line as follows:

-You can use the `selectorIcon` to add content to the start and end of the date-picker.
+You can use the `selector` to add content to the start and end of the date-picker.

Action Required: Update Prop Name in Date Picker Documentation

The documentation currently states:

You can use the `selectorIcon` to add content to the start and end of the date-picker.

According to the PR objectives, this should be updated to use selector instead of selectorIcon. Please update line 96 in apps/docs/content/docs/components/date-picker.mdx as follows:

-You can use the `selectorIcon` to add content to the start and end of the date-picker.
+You can use the `selector` to add content to the start and end of the date-picker.

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:

  • 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 generate docstrings to generate docstrings 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.

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.

@wingkwong wingkwong added this to the v2.7.6 milestone Mar 10, 2025
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.

2 participants