[Docs] Fix Chinese punctuation compliance in paddle.hub API docs#7810
Merged
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom Mar 1, 2026
Conversation
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>
|
感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7810.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
Contributor
There was a problem hiding this comment.
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。 |
There was a problem hiding this comment.
PR 描述里写的是将 默认值: False 改为 默认值:False(仍是英文冒号 :),但实际文档修改为 默认值:False(中文冒号 :)。为避免审查者/自动检查器理解偏差,建议同步修正 PR 描述中的示例与说明,使其与实际变更一致。
cutetocute
approved these changes
Mar 1, 2026
Echo-Nie
approved these changes
Mar 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixed documentation compliance issues in
paddle.hubAPI 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
默认值: Falsepattern violates this standard and should be默认值:False.Changes
docs/api/paddle/hub/help_cn.rst默认值: False→默认值:Falsedocs/api/paddle/hub/list_cn.rst默认值: False→默认值:Falsedocs/api/paddle/hub/load_cn.rst默认值: False→默认值:False**model** (str)-→**model** (str) -(bool,可选) -→(bool,可选) -Standards Reference
From
.github/copilot-instructions.md: