Skip to content

Add @since annotation to useChartLayout#7360

Merged
PavelVanecek merged 1 commit into
mainfrom
since
May 24, 2026
Merged

Add @since annotation to useChartLayout#7360
PavelVanecek merged 1 commit into
mainfrom
since

Conversation

@PavelVanecek

@PavelVanecek PavelVanecek commented May 24, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

Docs only

Summary by CodeRabbit

  • Documentation
    • Updated internal development documentation with version annotations.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

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: a0077c05-7cdf-43ee-92bd-38707afd44f8

📥 Commits

Reviewing files that changed from the base of the PR and between 3ef1f19 and aa6d710.

📒 Files selected for processing (1)
  • src/context/chartLayoutContext.tsx

Walkthrough

This PR adds a @since 3.9 JSDoc annotation to the deprecated useChartLayout hook in the chart layout context module. No runtime logic, function signatures, or exports were modified.

Changes

JSDoc Deprecation Annotation

Layer / File(s) Summary
JSDoc deprecation annotation for useChartLayout hook
src/context/chartLayoutContext.tsx		 Added a @since 3.9 JSDoc tag to the documented deprecation of the useChartLayout hook, providing version metadata without altering runtime behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • recharts/recharts#7338: Documentation-only updates adding/adjusting @since JSDoc annotations for exported hooks without changing runtime logic.
  • recharts/recharts#7326: Similar documentation-only JSDoc updates in src/context/chartLayoutContext.tsx adding @since 3.9 annotations to chart layout hooks.
  • recharts/recharts#6927: Modifies JSDoc metadata by adding @since annotations to hooks with no runtime or signature changes.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is minimal but appropriate for a documentation-only change. It clearly states 'Docs only' and specifies the @since annotation addition, though it lacks the structured format of the template. Consider following the repository's PR description template by adding sections like 'Motivation and Context' to explain why the @since annotation was added and what version it applies to.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a @since annotation to the useChartLayout hook documentation.
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 since

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

codecov Bot commented May 24, 2026 •
edited
Loading

Copy link
Copy Markdown

Bundle Report

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

Detailed changes
Bundle name Size Change
recharts/bundle-cjs 1.4MB 17 bytes (0.0%) ⬆️
recharts/bundle-es6 1.23MB 17 bytes (0.0%) ⬆️
recharts/bundle-treeshaking-cartesian 693.59kB 17 bytes (0.0%) ⬆️
recharts/bundle-treeshaking-polar 459.43kB 17 bytes (0.0%) ⬆️
recharts/bundle-treeshaking-treemap 386.54kB 17 bytes (0.0%) ⬆️
recharts/bundle-treeshaking-sunburst 346.83kB 17 bytes (0.0%) ⬆️
recharts/bundle-treeshaking-sankey 374.11kB 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 459.43kB 0.0%
view changes for bundle: recharts/bundle-treeshaking-treemap

Assets Changed:

Asset Name Size Change Total Size Change (%)
bundle.js 17 bytes 386.54kB 0.0%
view changes for bundle: recharts/bundle-es6

Assets Changed:

Asset Name Size Change Total Size Change (%)
context/chartLayoutContext.js 17 bytes 9.11kB 0.19%
view changes for bundle: recharts/bundle-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
context/chartLayoutContext.js 17 bytes 10.44kB 0.16%
view changes for bundle: recharts/bundle-treeshaking-sunburst

Assets Changed:

Asset Name Size Change Total Size Change (%)
bundle.js 17 bytes 346.83kB 0.0%
view changes for bundle: recharts/bundle-treeshaking-sankey

Assets Changed:

Asset Name Size Change Total Size Change (%)
bundle.js 17 bytes 374.11kB 0.0%
view changes for bundle: recharts/bundle-treeshaking-cartesian

Assets Changed:

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

@chromatic-com

chromatic-com Bot commented May 24, 2026 •
edited
Loading

Copy link
Copy Markdown

Tip

All tests passed and all changes approved!

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

@codecov

codecov Bot commented May 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.04%. Comparing base (3ef1f19) to head (aa6d710).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #7360   +/-   ##
=======================================
  Coverage   89.04%   89.04%           
=======================================
  Files         548      548           
  Lines       40546    40546           
  Branches     5570     5571    +1     
=======================================
  Hits        36105    36105           
  Misses       4432     4432           
  Partials        9        9

☔ 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

github-actions Bot commented May 24, 2026

Copy link
Copy Markdown
Contributor

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
PavelVanecek merged commit 8cde930 into main May 24, 2026
61 checks passed
@PavelVanecek
PavelVanecek deleted the since branch May 24, 2026 02:15
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