Skip to content

[Docs] Fix Chinese punctuation compliance in paddle.hub API docs#7810

Merged
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-hub-punctuation-compliance-ee6bc1b91307b8ed
Mar 1, 2026
Merged

[Docs] Fix Chinese punctuation compliance in paddle.hub API docs#7810
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-hub-punctuation-compliance-ee6bc1b91307b8ed

Conversation

@ooooo-create
Copy link
Collaborator

Summary

Fixed documentation compliance issues in paddle.hub API docs where English colons (:) were incorrectly used in Chinese-language parameter descriptions instead of Chinese colons (:).

Per the repository's documentation standards, Chinese documents should use Chinese punctuation throughout. The 默认值: False pattern violates this standard and should be 默认值:False.

Changes

docs/api/paddle/hub/help_cn.rst

  • Fixed English colon in default value description: 默认值: False默认值:False

docs/api/paddle/hub/list_cn.rst

  • Fixed English colon in default value description: 默认值: False默认值:False

docs/api/paddle/hub/load_cn.rst

  • Fixed English colon in default value description: 默认值: False默认值:False
  • Fixed missing space after parameter type: **model** (str)-**model** (str) -
  • Fixed double space before dash: (bool,可选) -(bool,可选) -

Standards Reference

From .github/copilot-instructions.md:

中文文档中尽量避免使用英文标点符号,如逗号、句号、引号等,均应使用中文标点符号

Generated by API Docs Checker


🔄 Synced from StatefulDust#19

Replace English colons with Chinese colons in default value descriptions
in hub API documentation files. Also fix missing space after parameter
type in load_cn.rst.

Affected files:
- docs/api/paddle/hub/help_cn.rst: 默认值: False -> 默认值:False
- docs/api/paddle/hub/list_cn.rst: 默认值: False -> 默认值:False
- docs/api/paddle/hub/load_cn.rst: 默认值: False -> 默认值:False, fix missing space in model param

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@paddle-bot
Copy link

paddle-bot bot commented Mar 1, 2026

感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7810.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明,请参考:飞桨文档预览工具

@github-actions
Copy link

github-actions bot commented Mar 1, 2026

📚 本次 PR 文档预览链接(点击展开)
ℹ️ 预览提醒
请等待 Docs-NEW 流水线运行完成后再点击预览链接,否则可能会看到旧版本内容或遇到链接无法访问的情况。

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

本 PR 针对 paddle.hub 中文 API 文档做格式合规修正,主要解决参数说明中默认值标点与排版不符合中文文档规范的问题,从而减少文档规范检查告警。

Changes:

  • 将参数默认值描述中的半角冒号 : 统一替换为全角冒号 ,并去除冒号后的空格(如 默认值:False)。
  • 修正 load_cn.rst 中个别参数项的排版细节(类型后缺失空格、重复空格等)。

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/api/paddle/hub/help_cn.rst force_reload 默认值描述的冒号标点规范化。
docs/api/paddle/hub/list_cn.rst force_reload 默认值描述的冒号标点规范化。
docs/api/paddle/hub/load_cn.rst 默认值冒号标点规范化,并修复参数列表排版空格问题。

- **model** (str) - 模型的名字。
- **source** (str,可选) - 指定 repo 托管的位置,支持 github、gitee 和 local,默认值:github。
- **force_reload** (bool,可选) - 指定是否强制拉取,默认值: False。
- **force_reload** (bool,可选) - 指定是否强制拉取,默认值False。
Copy link

Copilot AI Mar 1, 2026

Choose a reason for hiding this comment

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

PR 描述里写的是将 默认值: False 改为 默认值:False(仍是英文冒号 :),但实际文档修改为 默认值:False(中文冒号 )。为避免审查者/自动检查器理解偏差,建议同步修正 PR 描述中的示例与说明,使其与实际变更一致。

Copilot uses AI. Check for mistakes.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

pr 描述错了,可恶呐

Copy link
Collaborator

Choose a reason for hiding this comment

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

@cutetocute 小bot还自己approve上了??

@Echo-Nie Echo-Nie merged commit 8aa1297 into PaddlePaddle:develop Mar 1, 2026
9 checks passed
@ooooo-create ooooo-create added the HappyOpenSource 快乐开源活动issue与PR label Mar 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

HappyOpenSource 快乐开源活动issue与PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants