tiny-vue icon indicating copy to clipboard operation
tiny-vue copied to clipboard

fix(query-builder): document supplement

Open James-9696 opened this issue 1 month ago • 1 comments

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • [x] The commit message follows our Commit Message Guidelines
  • [ ] Tests for the changes have been added (for bug fixes / features)
  • [ ] Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • [ ] Bugfix
  • [ ] Feature
  • [ ] Code style update (formatting, local variables)
  • [ ] Refactoring (no functional changes, no api changes)
  • [ ] Build related changes
  • [ ] CI related changes
  • [ ] Documentation content changes
  • [x] Other... Please describe: 补充文档

What is the current behavior?

Issue Number: #3810

What is the new behavior?

Does this PR introduce a breaking change?

  • [ ] Yes
  • [x PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • [x] The commit message follows our Commit Message Guidelines
  • [ ] Tests for the changes have been added (for bug fixes / features)
  • [ ] Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • [ ] Bugfix
  • [ ] Feature
  • [ ] Code style update (formatting, local variables)
  • [ ] Refactoring (no functional changes, no api changes)
  • [ ] Build related changes
  • [ ] CI related changes
  • [ ] Documentation content changes
  • [x] Other... Please describe: 补充文档

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • [ ] Yes
  • [x] No

Other information

Summary by CodeRabbit

  • Documentation
    • Added comprehensive English translations for demo descriptions.
    • Enhanced formatting with code highlighting for technical terms and attributes.
    • Clarified and updated demo labels for consistency.
    • Standardized documentation structure and terminology across descriptions.

James-9696 avatar Nov 13 '25 03:11 James-9696

Walkthrough

Updated demo metadata file to add English translations for query-builder demo descriptions, introduced inline code formatting for technical terms, and changed the display-only-field demo label from "Basic" to "Simple Mode".

Changes

Cohort / File(s) Summary
Query-Builder Demo Metadata
examples/sites/demos/pc/app/query-builder/webdoc/query-builder.js
Added en-US translations for multiple demo descriptions; wrapped technical terms (e.g., max-height, bindProps, fields, children) with <code>...</code> formatting; updated display-only-field demo label to "Simple Mode"; standardized description structure and terminology.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Review accuracy and completeness of en-US translations against zh-CN originals
  • Verify consistent code formatting applied across all attribute names and examples
  • Confirm display-only-field label change aligns with naming conventions
  • Check HTML structure integrity of reformatted description blocks

Poem

🐰 Translations blooming, code tags gleaming, English descriptions now sweetly streaming, Simple Mode shines where Basic once lay, Demo docs dance in a fresh, formatted way! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix(query-builder): document supplement' is partially related to the changeset. It references 'query-builder' and 'document supplement,' which align with the file being modified and the addition of English translations and documentation improvements. However, the term 'fix' in the conventional commit prefix may be misleading, as the changes primarily add/enhance documentation rather than fixing a bug.
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

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.

coderabbitai[bot] avatar Nov 13 '25 03:11 coderabbitai[bot]