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

chore: fix typos #2300

Merged
merged 1 commit into from
May 30, 2024
Merged

chore: fix typos #2300

merged 1 commit into from
May 30, 2024

Conversation

xiaoxianBoy
Copy link
Contributor

@xiaoxianBoy xiaoxianBoy commented May 30, 2024

fix some typos

🤔 这个变动的性质是?

  • 新特性提交
  • 日常 bug 修复
  • 站点、文档改进
  • 演示代码改进
  • 组件样式/交互改进
  • TypeScript 定义更新
  • 包体积优化
  • 性能优化
  • 功能增强
  • 国际化改进
  • 重构
  • 代码风格优化
  • 测试用例
  • 分支合并
  • 其他改动(是关于什么的改动?)

🔗 相关 Issue

💡 需求背景和解决方案

☑️ 请求合并前的自查清单

⚠️ 请自检并全部勾选全部选项⚠️

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充
  • fork仓库代码是否为最新避免文件冲突
  • Files changed 没有 package.json lock 等无关文件

Summary by CodeRabbit

  • 文档
    • 修正了 Noticebar 组件描述中的拼写错误。
    • 修正了 ShortPassword 组件 length 属性描述中的拼写错误。
    • 修正了 Swipe 组件文档中 beforeClose 函数参数名的拼写错误。
    • 修正了 Tabbar 组件 dot 属性描述中的拼写错误。
    • 修正了 Table 组件文档中章节标题的拼写错误。

Signed-off-by: snoppy <michaleli@foxmail.com>
Copy link

coderabbitai bot commented May 30, 2024

Walkthrough

这次更改主要集中在文档中的拼写错误修正。涉及多个组件的描述性文本和参数名称的纠正,以确保文档的准确性和可读性。这些更改不会影响到导出的或公共的实体声明。

Changes

文件路径 更改摘要
src/packages/noticebar/doc.en-US.md 修正了关于消息通知组件描述中的拼写错误。
src/packages/shortpassword/doc.en-US.md 修正了 ShortPassword 组件中 length 属性描述的拼写错误。
src/packages/swipe/doc.md 修正了 beforeClose 函数中参数名称 postionposition
src/packages/tabbar/doc.en-US.md 修正了 Tabbar 组件中 dot 属性描述的拼写错误。
src/packages/table/doc.en-US.md 修正了 Table 组件文档中标题的拼写错误。

Poem

代码如诗,文档如歌,
错字改正,清晰明了。
组件功能,依旧如昨,
开发者心,欢喜若何。
🐰✨


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 8855689 and b9e7200.
Files selected for processing (5)
  • src/packages/noticebar/doc.en-US.md (1 hunks)
  • src/packages/shortpassword/doc.en-US.md (1 hunks)
  • src/packages/swipe/doc.md (1 hunks)
  • src/packages/tabbar/doc.en-US.md (1 hunks)
  • src/packages/table/doc.en-US.md (1 hunks)
Additional Context Used
Markdownlint (12)
src/packages/noticebar/doc.en-US.md (4)

76: Expected: 1; Actual: 2
Multiple consecutive blank lines


58: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines


158: null
Files should end with a single newline character


144: null
Link fragments should be valid

src/packages/shortpassword/doc.en-US.md (2)

98: null
Files should end with a single newline character


91: null
Link fragments should be valid

src/packages/swipe/doc.md (2)

41: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


354: null
Files should end with a single newline character

src/packages/tabbar/doc.en-US.md (2)

133: null
Files should end with a single newline character


119: null
Link fragments should be valid

src/packages/table/doc.en-US.md (2)

160: null
Files should end with a single newline character


151: null
Link fragments should be valid

Additional comments not posted (5)
src/packages/shortpassword/doc.en-US.md (1)

76-76: 修正了 length 属性描述中的拼写错误,从 "lenght" 改为 "length",这有助于提高文档的准确性和专业性。

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

111-111: 修正了 dot 属性描述中的拼写错误,从 "Whther Bagde is dotted" 改为 "Whether Badge is dotted",这有助于提高文档的准确性和专业性。

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

111-111: 修正了节标题中的拼写错误,从 "Sticky Rright Column" 改为 "Sticky Right Column",这有助于提高文档的准确性和专业性。

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

5-5: 更新了描述,明确了消息通知是在连续循环中显示的,这有助于用户更好地理解组件的功能。

src/packages/swipe/doc.md (1)

257-260: 修正了 beforeClose 函数文档中的参数名,从 "postion" 改为 "position",这有助于提高代码的准确性和可读性。


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.

@xiaoyatong xiaoyatong merged commit bbdfc59 into jdf2e:next May 30, 2024
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.

None yet

2 participants