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

docs(attachments): fix typo #537

Merged
merged 1 commit into from
Feb 17, 2025
Merged

Conversation

wzc520pyfm
Copy link
Contributor

@wzc520pyfm wzc520pyfm commented Feb 16, 2025

Summary by CodeRabbit

  • 文档更新
    • 将组件名称从“Attachment”统一更改为“Attachments”,提高了命名的一致性和清晰度。
    • 更新了组件描述、属性标题以及设计令牌的引用,确保所有语言版本(包括英文和中文)同步调整并准确反映最新信息。

Copy link
Contributor

coderabbitai bot commented Feb 16, 2025

📝 Walkthrough

Walkthrough

此次变更主要对组件文档中的名称进行了更新,将原本的“Attachment”更改为“Attachments”。所有相关描述、标题、属性标题及组件标记内容均已统一调整,以确保文档中对组件名称的引用保持一致。

Changes

文件路径 更改摘要
components/attachments/index.en-US.md
components/attachments/index.zh-CN.md
将组件名称从 “Attachment” 更新为 “Attachments”,同时更新了标题、描述、属性头以及组件标记中的相关引用。

Suggested reviewers

  • afc163

Poem

我是一只跳跃的小兔子,
在代码花园里欢快又自在,
轻轻改名添点诗意,
“Attachment”迎来“Attachments”新姿,
代码世界里春风得意 🐰🌸!


📜 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 9b7557d and 0c2f8ef.

📒 Files selected for processing (2)
  • components/attachments/index.en-US.md (4 hunks)
  • components/attachments/index.zh-CN.md (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test / react component workflow
  • GitHub Check: build preview
  • GitHub Check: size
🔇 Additional comments (8)
components/attachments/index.zh-CN.md (4)

6-6: 标题已更新为 "Attachments"。

此处将单数 “Attachment” 修改为复数 “Attachments”,符合组件命名一致性的要求,无需进一步修改。


17-17: 更新组件描述中的名称。

描述中已将 “Attachment 组件” 修改为 “Attachments 组件”,确保描述与新命名保持一致,信息准确。


32-32: 属性标题更新为 "AttachmentsProps"。

组件属性的标题已由单数改为复数,保证属性声明与组件名称保持一致,增强了文档的一致性。


69-69: 组件令牌引用已更新。

通过将 <ComponentTokenTable component="Attachments"></ComponentTokenTable> 中的组件名称调整为 “Attachments”,使各处引用统一,便于后续维护。

components/attachments/index.en-US.md (4)

6-6: Title 已更新为 "Attachments"。

标题部分已由原先的单数形式改为复数,确保中英文文档均采用一致的组件命名规则。


16-16: 组件使用描述已更新。

文档描述中将组件名称更新为 “Attachments”,确保描述与实际组件名称一一对应,提高了文档的准确性。


29-29: 组件属性标题更新为 "AttachmentsProps"。

将属性标题从单数修改为复数,有助于在文档中统一命名风格,增强文档整体的可读性和规范性。


66-66: 设计令牌组件引用更新。

更改 <ComponentTokenTable component="Attachments"></ComponentTokenTable> 后,中英文文档中各处组件引用已统一,符合最佳实践,便于维护。


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

github-actions bot commented Feb 16, 2025

Preview is ready

Copy link

Walkthrough

This pull request addresses a typo in the documentation files for the attachments component. The changes involve correcting the component name from "Attachment" to "Attachments" in both English and Chinese documentation files, ensuring consistency and clarity.

Changes

File Summary
components/attachments/index.en-US.md Corrected the component name from "Attachment" to "Attachments" and updated related descriptions and headings.
components/attachments/index.zh-CN.md Corrected the component name from "Attachment" to "Attachments" and updated related descriptions and headings.

@@ -13,7 +13,7 @@ demo:

## When To Use

The Prompts component is used to display a predefined set of questions or suggestion that are relevant to the current context.
The Attachments component is used in scenarios where a set of attachment information needs to be displayed.

Choose a reason for hiding this comment

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

Ensure that the component name change from "Attachment" to "Attachments" is consistently applied throughout the documentation to avoid confusion.

@@ -14,7 +14,7 @@ demo:

## 何时使用

Attachment 组件用于需要展示一组附件信息集合的场景。
Attachments 组件用于需要展示一组附件信息集合的场景。

Choose a reason for hiding this comment

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

Ensure that the component name change from "Attachment" to "Attachments" is consistently applied throughout the documentation to avoid confusion.

Copy link

codecov bot commented Feb 16, 2025

Bundle Report

Bundle size has no change ✅

Copy link

codecov bot commented Feb 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.79%. Comparing base (9b7557d) to head (0c2f8ef).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #537   +/-   ##
=======================================
  Coverage   91.79%   91.79%           
=======================================
  Files          67       67           
  Lines        1463     1463           
  Branches      371      386   +15     
=======================================
  Hits         1343     1343           
  Misses        120      120           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@afc163 afc163 merged commit 3c79fae into ant-design:main Feb 17, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants