docs: add @since 3.9 annotation to hooks by PavelVanecek · Pull Request #7326 · recharts/recharts

PavelVanecek · 2026-05-14T11:01:01Z

Docs only

#7325

Summary by CodeRabbit

Documentation
- Added "since 3.9" version annotations to public API documentation to improve clarity for consumers and tooling.

coderabbitai · 2026-05-14T11:01:16Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6a537ee4-2efa-45a2-b157-5158335e3d16

📥 Commits

Reviewing files that changed from the base of the PR and between 73affbc and 362c11b.

📒 Files selected for processing (1)

src/context/chartLayoutContext.tsx

✅ Files skipped from review due to trivial changes (1)

src/context/chartLayoutContext.tsx

Walkthrough

This pull request updates JSDoc in the chart layout context module by adding @since 3.9 annotations to useCartesianChartLayout and usePolarChartLayout. No executable code, signatures, or runtime behavior changed.

Changes

Documentation Updates

Layer / File(s)	Summary
Chart layout hook documentation (`@since` annotations) `src/context/chartLayoutContext.tsx`	`@since 3.9` annotations are added to JSDoc for `useCartesianChartLayout` and `usePolarChartLayout` hooks.

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

recharts/recharts#6927: Adds @since/version annotations to JSDoc documentation for hooks without runtime changes.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description lacks required template sections including Related Issue link, Motivation and Context, How Has This Been Tested, and Types of changes checklist.	Fill in the required sections from the template, particularly the Related Issue, Motivation and Context, and Types of changes sections to meet repository standards.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding `@since` 3.9 annotations to hooks, which is the sole modification in the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch hooks-since

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

Generate code and open pull requests
Plan features and break down work
Investigate incidents and troubleshoot customer tickets together
Automate recurring tasks and respond to alerts with triggers
Summarize progress and report instantly

Built for teams:

Shared memory across your entire org—no repeating context
Per-thread sandboxes to safely plan and execute work
Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

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.}

codecov · 2026-05-14T11:04:25Z

Bundle Report

Changes will increase total bundle size by 102 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
recharts/bundle-cjs	1.4MB	34 bytes (0.0%) ⬆️
recharts/bundle-es6	1.23MB	34 bytes (0.0%) ⬆️
recharts/bundle-treeshaking-cartesian	701.83kB	17 bytes (0.0%) ⬆️
recharts/bundle-treeshaking-polar	485.22kB	17 bytes (0.0%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: recharts/bundle-treeshaking-polar

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`bundle.js`	17 bytes	485.22kB	0.0%

view changes for bundle: recharts/bundle-treeshaking-cartesian

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`bundle.js`	17 bytes	701.83kB	0.0%

view changes for bundle: recharts/bundle-es6

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`context/chartLayoutContext.js`	34 bytes	9.09kB	0.38%

view changes for bundle: recharts/bundle-cjs

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`context/chartLayoutContext.js`	34 bytes	10.42kB	0.33%

chromatic-com · 2026-05-14T11:08:28Z

Tip

All tests passed and all changes approved!

🟢 UI Tests: 193 tests unchanged
🟢 UI Review: 193 stories published -- no changes
Storybook Publish: 193 stories published

codecov · 2026-05-14T11:10:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.99%. Comparing base (5e9f470) to head (362c11b).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7326   +/-   ##
=======================================
  Coverage   88.99%   88.99%           
=======================================
  Files         541      541           
  Lines       41136    41136           
  Branches     5568     5569    +1     
=======================================
  Hits        36610    36610           
  Misses       4518     4518           
  Partials        8        8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions · 2026-05-14T11:12:59Z

Staging Deployment Details

These deployments will remain available for 30 days.

To update snapshots: Comment /update-snapshots on this PR to automatically update the baseline screenshots.

PavelVanecek · 2026-05-14T11:29:50Z

@copilot run prettier please

Agent-Logs-Url: https://github.com/recharts/recharts/sessions/ddf8441e-53ea-4ad4-8826-39a9c1a7f283 Co-authored-by: PavelVanecek <[email protected]>

Copilot · 2026-05-14T11:38:26Z

@copilot run prettier please

Done — prettier removed trailing whitespace from two JSDoc comment lines in chartLayoutContext.tsx (commit 362c11b).

github-actions · 2026-05-14T12:37:04Z

Staging Deployment Details

These deployments will remain available for 30 days.

To update snapshots: Comment /update-snapshots on this PR to automatically update the baseline screenshots.

docs: add @SInCE 3.9 annotation to hooks

73affbc

Copilot started work on behalf of PavelVanecek May 14, 2026 11:30 View session

style: run prettier on chartLayoutContext.tsx

362c11b

Agent-Logs-Url: https://github.com/recharts/recharts/sessions/ddf8441e-53ea-4ad4-8826-39a9c1a7f283 Co-authored-by: PavelVanecek <[email protected]>

Copilot finished work on behalf of PavelVanecek May 14, 2026 11:46

PavelVanecek merged commit a9473f6 into main May 14, 2026
60 checks passed

PavelVanecek deleted the hooks-since branch May 14, 2026 12:43

coderabbitai Bot mentioned this pull request May 16, 2026

Add since annotation to useActiveTooltipDataPoints #7338

Merged

coderabbitai Bot mentioned this pull request May 24, 2026

Add @since annotation to useChartLayout #7360

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: add @since 3.9 annotation to hooks#7326

docs: add @since 3.9 annotation to hooks#7326
PavelVanecek merged 2 commits into
mainfrom
hooks-since

PavelVanecek commented May 14, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented May 14, 2026 •

edited

Loading

❌ Failed checks (1 warning)

Uh oh!

codecov Bot commented May 14, 2026 •

edited

Loading

Assets Changed:

Assets Changed:

Assets Changed:

Assets Changed:

Uh oh!

chromatic-com Bot commented May 14, 2026 •

edited

Loading

All tests passed and all changes approved!

Uh oh!

codecov Bot commented May 14, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 14, 2026

Uh oh!

PavelVanecek commented May 14, 2026

Uh oh!

Copilot AI commented May 14, 2026

Uh oh!

github-actions Bot commented May 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

PavelVanecek commented May 14, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

❌ Failed checks (1 warning)

Uh oh!

codecov Bot commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

Assets Changed:

Assets Changed:

Assets Changed:

Uh oh!

chromatic-com Bot commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All tests passed and all changes approved!

Uh oh!

codecov Bot commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented May 14, 2026

Uh oh!

PavelVanecek commented May 14, 2026

Uh oh!

Copilot AI commented May 14, 2026

Uh oh!

github-actions Bot commented May 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

PavelVanecek commented May 14, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented May 14, 2026 •

edited

Loading

codecov Bot commented May 14, 2026 •

edited

Loading

chromatic-com Bot commented May 14, 2026 •

edited

Loading

codecov Bot commented May 14, 2026 •

edited

Loading