Skip to content

docs: point Pie activeShape to shape#6670

Merged
ckifer merged 1 commit intomainfrom
shape-alt-docs
Nov 23, 2025
Merged

docs: point Pie activeShape to shape#6670
ckifer merged 1 commit intomainfrom
shape-alt-docs

Conversation

@ckifer
Copy link
Member

@ckifer ckifer commented Nov 23, 2025 •
edited by coderabbitai bot
Loading

Follow up, point deprecated shape props to new shape prop

Summary by CodeRabbit

  • Deprecations
    • The activeShape and inactiveShape properties in the Pie chart component are now marked as deprecated. Users should use the shape property instead.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 23, 2025 •
edited
Loading

Walkthrough

Updated English descriptions for activeShape and inactiveShape properties in the Pie API documentation to mark them as deprecated, recommending the use of the shape prop instead. Chinese descriptions remain unchanged.

Changes

Cohort / File(s) Summary
Pie API Deprecation Notices
www/src/docs/api/Pie.ts		 Updated English descriptions for activeShape and inactiveShape to mark them as deprecated with recommendation to use shape instead

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • PavelVanecek

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is minimal but the PR is documentation-only with clear intent. The template requires detailed sections, most of which are not filled out. Expand the description to include: motivation for deprecating these props, related issue link, and which checkbox applies (likely 'My change requires a change to the documentation').
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: marking deprecated Pie props and pointing users to the new shape prop.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch shape-alt-docs
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d85a2d1 and 350392a.

📒 Files selected for processing (1)
  • www/src/docs/api/Pie.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Build, Test, Pack
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
www/src/docs/api/Pie.ts (1)

189-189: Deprecation notices are clear and actionable. ✓

The changes correctly append deprecation notices to both activeShape (line 189) and inactiveShape (line 206) in the English descriptions, directing users to the shape prop as the replacement. The messaging is consistent, and the referenced shape prop (lines 173–181) already documents how to handle conditional rendering via the isActive flag.

The existing deprecated: true flags (lines 187, 204) are now paired with explicit guidance in the descriptions, which improves discoverability for API consumers.

Also applies to: 206-206

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

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.

@ckifer ckifer merged commit 41c2b94 into main Nov 23, 2025
7 checks passed
@ckifer ckifer deleted the shape-alt-docs branch November 23, 2025 05:25
@codecov
Copy link

codecov bot commented Nov 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.03%. Comparing base (d85a2d1) to head (350392a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #6670   +/-   ##
=======================================
  Coverage   94.03%   94.03%           
=======================================
  Files         497      497           
  Lines       42609    42609           
  Branches     4871     4871           
=======================================
  Hits        40066    40066           
  Misses       2538     2538           
  Partials        5        5

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

@codecov
Copy link

codecov bot commented Nov 23, 2025

Bundle Report

Bundle size has no change ✅

@coderabbitai coderabbitai bot mentioned this pull request Nov 24, 2025
Merged
7 tasks
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

@ckifer