Skip to content

fix: 修复注解错误 - #6763

Merged
jinmao88 merged 1 commit into
vbenjs:mainfrom
CupOfBread:main
Sep 23, 2025
Merged

jinmao88 merged 1 commit into
vbenjs:mainfrom
CupOfBread:main

Conversation

@CupOfBread

@CupOfBread CupOfBread commented Sep 23, 2025 •

Copy link
Copy Markdown
Contributor

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • Documentation
    • Clarified the description of the “collapsed” setting for form components when the collapse button is shown. The docs now explicitly state that true means collapsed and false means expanded, improving clarity for configuration.
    • Updated the Chinese copy to accurately reflect the collapsed state.
    • No functional changes; existing forms and behavior remain the same.

@changeset-bot

changeset-bot Bot commented Sep 23, 2025

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3df8251

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

@coderabbitai

coderabbitai Bot commented Sep 23, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

Documentation text for FormRenderProps.collapsed in packages/@core/ui-kit/form-ui/src/types.ts was updated to indicate it controls folded state (effective when showCollapseButton=true) and clarifies true=false meanings. No type or behavior changes.

Changes

Cohort / File(s) Summary of Changes
Form UI types doc update
packages/@core/ui-kit/form-ui/src/types.ts
Updated JSDoc for FormRenderProps.collapsed to describe folded state and specify true: 折叠, false: 展开; no type or logic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • anncwb
  • mynetfan
  • jinmao88

Poem

I nudge a note with gentle paw,
“True means fold,” I ink the law.
Forms don’t change, just words align,
Buttons know the proper sign.
Hippity-hop through types I tread,
Clarity tucked in docs instead. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The PR description follows the template structure and has checkboxes ticked, but it provides no substantive explanation of what was changed, why, or how it was validated — the Description section is left as template comments. The raw_summary shows a documentation correction to FormRenderProps.collapsed in packages/@core/ui-kit/form-ui/src/types.ts, information that should be explicitly stated in the description. Because the template expects a descriptive summary and (for bug fixes) related issue or test details, the current description is incomplete. Please update the Description to state concisely what was changed (for example: corrected the FormRenderProps.collapsed annotation in packages/@core/ui-kit/form-ui/src/types.ts), why the change was needed, and reference any related issue or PR; also include how the fix was validated (tests run or manual steps) and confirm whether only documentation text was modified. Keep the existing checklist entries but replace the placeholder comments with this concrete information so reviewers can quickly verify the intent and scope.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title "fix: 修复注解错误" is concise and accurately describes the primary change in this PR — a corrected annotation in packages/@core/ui-kit/form-ui/src/types.ts (FormRenderProps.collapsed) as shown in the provided summary. It uses the conventional "fix:" prefix and avoids unnecessary detail, so a teammate scanning history can understand the intent. The title does not misrepresent the change or include unrelated information.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 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 482ce98 and 3df8251.

📒 Files selected for processing (1)
  • packages/@core/ui-kit/form-ui/src/types.ts (1 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: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (2)
packages/@core/ui-kit/form-ui/src/types.ts (2)

280-282: Annotation fix is correct.

Swapping “是否展开” to “是否折叠” and clarifying true/false aligns the docs with the property name; no type/behavior change.


280-282: Document collapsed default and tighten wording.

Confirm the runtime default; if it's false, apply:

-   * 是否折叠,在showCollapseButton=true下生效
-   * true:折叠 false:展开
+   * 是否折叠。当 showCollapseButton 为 true 时生效。
+   * true 表示“折叠”,false 表示“展开”。
+   * @default false

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

@jinmao88
jinmao88 merged commit 81bb745 into vbenjs:main Sep 23, 2025
1 check passed
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 24, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants