docs: 完善Cascader文档示例 #350

jynba · 2024-06-13T12:51:15Z

规范文档用例

netlify · 2024-06-13T12:52:18Z

✅ Deploy Preview for nutui-uniapp ready!

Name	Link
🔨 Latest commit	`1540023`
🔍 Latest deploy log	https://app.netlify.com/sites/nutui-uniapp/deploys/666aecedff2e1100087eef0f
😎 Deploy Preview	https://deploy-preview-350--nutui-uniapp.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 96 (no change from production) Accessibility: 97 (no change from production) Best Practices: 100 (no change from production) SEO: 92 (no change from production) PWA: 70 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai · 2024-06-13T12:52:37Z

Walkthrough

这些变更主要涉及两个文档文件的修正工作。一个是添加了一个逗号以修正 JSON 格式问题，另一个则是修正了一个内置动画名称中的拼写错误。

Changes

文件路径	修改摘要
`docs/components/dentry/cascader.md`	在一个导出对象的子对象列表里添加了一个逗号
`docs/components/basic/transition.md`	将动画名称中的拼写错误从 `f`ade-left`修正为`fade-left`

Poem

在代码的世界里，我们轻舞飞扬，
修正小错，格式更整齐。
动画的名字，变得更清晰，
小兔子欢欣，脚步轻盈。
细微之处见功夫，编程如画，
闪亮在这六月天。

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.
- @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.

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (2)

docs/components/dentry/cascader.md (2)

Line range hint 3-3: 建议使用二级标题（##）而不是三级标题（###）来开始这部分内容，以符合标题级别递增的常规要求。

Line range hint 366-366: 请在“主题定制”标题前后添加空白行，以符合Markdown的格式规范。

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bebc8a7 and 6726f86.

Files selected for processing (1)

docs/components/dentry/cascader.md (1 hunks)

Additional context used

Markdownlint

docs/components/dentry/cascader.md

3-3: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time

366-366: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines

Additional comments not posted (1)

docs/components/dentry/cascader.md (1)

69-69: 请在对象列表中添加逗号以保持一致的格式。

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

docs/components/basic/transition.md (1)
Line range hint 3-3: 请注意Markdown标题级别的递增，从一级标题后应该使用二级标题，而不是直接跳到三级标题，这有助于保持文档结构的清晰和有序。
- ### 介绍
+ ## 介绍

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6726f86 and 1540023.

Files selected for processing (1)

docs/components/basic/transition.md (1 hunks)

Additional context used

Markdownlint

docs/components/basic/transition.md

3-3: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time

Additional comments not posted (1)

docs/components/basic/transition.md (1)

37-37: 修正了动画名称中的拼写错误，从 fade-left改为fade-left`，有助于提高文档的准确性和专业性。

xiaohe0601 · 2024-06-14T01:37:33Z

thx!

@input

* refactor: defineOptions instead of two script * refactor: once more * docs(cascader,transition): 修复 Cascader,Transition 文档示例错误 (#350) * docs: 完善Cascader文档示例 * docs: 完善transition文档规范 --------- Co-authored-by: xujiayu <xujiayu@motern.com> * refactor: once more * refactor: once more * fix: 修复comment生产环境web端卡死 (#352) * fix: 修复comment生产环境web端卡死 * fix: 示例环境判断错误 * style: comment demo --------- Co-authored-by: 小何同学 <59353463+xiaohe0601@users.noreply.github.com> * refactor: once more * docs(swiper): 完善Swiper文档示例 (#354) * refactor: once more * chore: disable package-manager-strict * refactor: once more * refactor: once more * refactor: once more * refactor: once more * fix(actionsheet): 修复custom-style表现异常 (#360) * fix(actionsheet): 修复custom-style表现异常 * refactor: once more * refactor: once more * docs(popup): z-index说明 * fix(popup): 修复z-index表现异常 (#364) * chore(overlay): 修复zIndex类型错误 * docs: 更换官网域名 * docs: update changelog * chore: release v1.7.11 * fix(input): 修复由于#324、#325引出的blur事件失效 * docs: update changelog * chore: release v1.7.12 * chore(icon): fix scss warning * chore(tabs): fix scss warning * docs: 更换官网域名 * chore: fix example package eslint config * feat(menu): add scroll-top prop (#377) * feat(menu): add scroll-top prop * docs(menu): add scroll-top prop * docs: fix page scroll * fix(navbar): 修复 navbar safe-area-inset-top 不生效的问题 (#379) * fix(navbar): 修复 navbar safe-area-inset-top 不生效的问题 --------- Co-authored-by: 小何同学 <59353463+xiaohe0601@users.noreply.github.com> * fix(popup,safearea): 修复部分低版本系统safearea不生效问题 * fix(input): fix @input compile error * fix(avatar): 修复支付宝小程序不支持??语法 * fix(form): 修复支付宝小程序不支持??语法 * docs: update changelog * chore: release v1.7.13 * feat(cell): 新增icon、clickable属性 (#384) * feat(cell): 新增icon、clickable属性 * feat(checkbox): 新增checked-value、unchecked-value属性 (#385) * fix(cell): fix merge error * refactor: price、progress * refactor: radio、radio-group * refactor: range * docs(overlay): 修复示例z-index表现异常 * fix(range): 修复点击控制导致NaN问题 * docs: update changelog * chore: release v1.7.14 * fix(range): 修复可能存在flex-shrink为0时的样式异常 --------- Co-authored-by: Xu Jiayu <75623303+jynba@users.noreply.github.com> Co-authored-by: xujiayu <xujiayu@motern.com> Co-authored-by: yang1206 <yang1206@outlook.com.tr> Co-authored-by: qd_whs <64092346+qd-xiaowang@users.noreply.github.com> Co-authored-by: WilliamChan <122583055+w-WilliamChan@users.noreply.github.com>

docs: 完善Cascader文档示例

6726f86

pull-request-size bot added the size/XS label Jun 13, 2024

coderabbitai bot reviewed Jun 13, 2024

View reviewed changes

docs: 完善transition文档规范

1540023

coderabbitai bot reviewed Jun 13, 2024

View reviewed changes

xiaohe0601 merged commit bedfc19 into nutui-uniapp:main Jun 14, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: 完善Cascader文档示例 #350

docs: 完善Cascader文档示例 #350

jynba commented Jun 13, 2024 •

edited

Loading

netlify bot commented Jun 13, 2024 •

edited

Loading

coderabbitai bot commented Jun 13, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

coderabbitai bot left a comment

xiaohe0601 commented Jun 14, 2024

docs: 完善Cascader文档示例 #350

docs: 完善Cascader文档示例 #350

Conversation

jynba commented Jun 13, 2024 • edited Loading

netlify bot commented Jun 13, 2024 • edited Loading

✅ Deploy Preview for nutui-uniapp ready!

coderabbitai bot commented Jun 13, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

xiaohe0601 commented Jun 14, 2024

jynba commented Jun 13, 2024 •

edited

Loading

netlify bot commented Jun 13, 2024 •

edited

Loading

coderabbitai bot commented Jun 13, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)