Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

修正参数名 #3088

Merged
merged 3 commits into from
May 25, 2024
Merged

修正参数名 #3088

merged 3 commits into from
May 25, 2024

Conversation

hainuo
Copy link
Contributor

@hainuo hainuo commented May 21, 2024

更正参数名 showClearIcon 为show-clear-icon

这个 PR 做了什么? (简要描述所做更改)

这个 PR 是什么类型? (至少选择一个)

  • feat: 新特性提交
  • fix: bug 修复
  • docs: 文档改进
  • style: 组件样式/交互改进
  • type: 类型定义更新
  • perf: 性能、包体积优化
  • refactor: 代码重构、代码风格优化
  • test: 测试用例
  • chore(deps): 依赖升级
  • chore(demo): 演示代码改进
  • chore(locale): 国际化改进
  • chore: 其他改动(是关于什么的改动?)

这个 PR 涉及以下平台:

  • NutUI H5 @nutui/nutui
  • NutUI Taro @nutui/nutui-taro

这个 PR 是否已自测:

Summary by CodeRabbit

  • 文档
    • Input 组件文档中的属性 showClearIcon 重命名为 show-clear-icon,以提高一致性和清晰度。

更正参数名 showClearIcon 为show-clear-icon
Copy link

coderabbitai bot commented May 21, 2024

Walkthrough

此次变更的总体概述是将 Input 组件文档中的 showClearIcon 属性重命名为 show-clear-icon,以提升一致性和清晰度。

Changes

文件路径 更改摘要
.../src/packages/__VUE/input/doc.md showClearIcon 属性重命名为 show-clear-icon
.../src/packages/__VUE/input/doc.en-US.md showClearIcon 属性重命名为 show-clear-icon
.../src/packages/__VUE/input/doc.taro.md showClearIcon 属性重命名为 show-clear-icon

🐇✨
代码如诗,变更如画,
清晰一致,文档无瑕。
组件更新,春风拂面,
未来可期,齐心协力。
🌸

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (2)
src/packages/__VUE/input/doc.md (2)

Line range hint 1-1: 请将标题级别从 ### 改为 ##,以保持标题级别的递增一致性。

- ### 介绍
+ ## 介绍

Line range hint 117-117: 请检查此行的表格列数,确保每行数据完整。

- | 参数 | 说明 | 类型 | 默认值 |
+ | 参数 | 说明 | 类型 | 默认值 | 描述 |
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between f0e3799 and 25b9e92.
Files selected for processing (1)
  • src/packages/__VUE/input/doc.md (1 hunks)
Additional comments not posted (2)
src/packages/__VUE/input/doc.md (2)

99-99: 参数名更改正确,以增强文档的一致性和清晰度。


Line range hint 154-154: 请确保链接片段有效,以避免文档中的死链接。

@eiinu
Copy link
Member

eiinu commented May 21, 2024

可以同步修改一下 doc.en-US.mddoc.taro.md 文档中相同的部分

@hainuo
Copy link
Contributor Author

hainuo commented May 25, 2024

可以同步修改一下 doc.en-US.mddoc.taro.md 文档中相同的部分

ok. 晓得了 没关注过其他组件 我修改一下

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (4)
src/packages/__VUE/input/doc.taro.md (2)

Line range hint 3-3: 请修正标题级别,确保标题级别逐级递增,避免跳跃。

- ### 介绍
+ ## 介绍

Line range hint 123-123: 表格列数不匹配,请确保每行的单元格数量一致。

- | 参数 | 说明 | 类型 | 默认值 |
+ | 参数 | 说明 | 类型 | 默认值 | 说明 |
src/packages/__VUE/input/doc.en-US.md (2)

Line range hint 3-3: Please correct the heading levels to ensure they increment by one level at a time.

- ### Intro
+ ## Intro

Line range hint 106-106: The table column count does not match, please ensure each row has the same number of cells.

- | Event | Description | Arguments |
+ | Event | Description | Arguments | Description |
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 25b9e92 and b0541d8.
Files selected for processing (2)
  • src/packages/__VUE/input/doc.en-US.md (1 hunks)
  • src/packages/__VUE/input/doc.taro.md (1 hunks)
Additional Context Used
Markdownlint (7)
src/packages/__VUE/input/doc.en-US.md (4)

3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time


94: null
Spaces inside code span elements


143: null
Link fragments should be valid


106: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count

src/packages/__VUE/input/doc.taro.md (3)

3: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time


152: null
Link fragments should be valid


123: Expected: 3; Actual: 2; Too few cells, row will be missing data
Table column count

Additional comments not posted (2)
src/packages/__VUE/input/doc.taro.md (1)

103-103: 参数名已从 showClearIcon 更改为 show-clear-icon,以保持一致性和提高文档的清晰度。

src/packages/__VUE/input/doc.en-US.md (1)

88-88: Parameter name has been changed from showClearIcon to show-clear-icon to maintain consistency and improve clarity in the documentation.

@eiinu eiinu merged commit e23b386 into jd-opensource:v4 May 25, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants