Skip to content

[Docs] Add @since annotations to hooks#6927

Merged
PavelVanecek merged 1 commit into
mainfrom
since
Jan 25, 2026
Merged

[Docs] Add @since annotations to hooks#6927
PavelVanecek merged 1 commit into
mainfrom
since

Conversation

@PavelVanecek

@PavelVanecek PavelVanecek commented Jan 25, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Enhanced API documentation with version availability information. Five hooks now clearly display their introduction versions across Recharts 3.0–3.2, making it easier for developers to quickly identify feature compatibility and understand which library versions support each hook.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Jan 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

Version annotations were added to hook documentation across the codebase, marking versioning milestones: useActiveTooltipLabel (3.0), useOffset and usePlotArea (3.1), and useXAxisDomain and useYAxisDomain (3.2). No functional changes were introduced.

Changes

Cohort / File(s) Summary
Source Code JSDoc Annotations
src/hooks.ts		 Added @since tags to 5 hooks indicating version availability: useActiveTooltipLabel (3.0), useOffset (3.1), usePlotArea (3.1), useXAxisDomain (3.2), useYAxisDomain (3.2).
Storybook Hook Documentation
storybook/stories/API/hooks/useOffset.mdx, storybook/stories/API/hooks/usePlotArea.mdx		 Added "Available since Recharts 3.1" version notes to Description sections.
API Documentation
www/src/docs/api/useActiveTooltipLabelAPI.tsx, www/src/docs/api/useOffsetAPI.tsx, www/src/docs/api/usePlotAreaAPI.tsx, www/src/docs/api/useXAxisDomainAPI.tsx, www/src/docs/api/useYAxisDomainAPI.tsx		 Added "Available since Recharts X.Y" version availability notes to API doc descriptions across multiple hooks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • ckifer
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is missing entirely; no description was provided by the author to explain the motivation, context, or testing approach. Add a comprehensive pull request description including motivation, context, how changes were tested, and which checklist items apply to this documentation update.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding @since annotations to document when hooks were introduced.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings

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.

@PavelVanecek
PavelVanecek merged commit 81a3d9c into main Jan 25, 2026
6 of 10 checks passed
@PavelVanecek
PavelVanecek deleted the since branch January 25, 2026 06:45
This was referenced May 14, 2026
Merged
Merged
@coderabbitai coderabbitai Bot mentioned this pull request May 24, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@PavelVanecek