[Docs] Fix punctuation standards in 3 Chinese API docs#7797
Merged
SigureMo merged 1 commit intoPaddlePaddle:developfrom Feb 28, 2026
Conversation
Fix the following issues in Chinese API documentation to comply with documentation standards: 1. docs/api/paddle/distributed/stream/alltoall_single_cn.rst: - Change English colon ':' separator to ' - ' in parameter descriptions 2. docs/api/paddle/incubate/nn/FusedDropoutAdd_cn.rst: - Change English colon ':' separator to ' - ' in parameter descriptions - Replace English comma ',' with Chinese comma '，' in type annotations - Replace English period '.' with Chinese period '。' in shape descriptions - Replace English parentheses and commas in descriptive text 3. docs/api/paddle/incubate/nn/functional/fused_dropout_add_cn.rst: - Change English colon ':' separator to ' - ' in parameter descriptions - Replace English comma ',' with Chinese comma '，' in type annotations - Replace English comma ',' with Chinese enumeration mark '、' in data type lists - Replace English period '.' with Chinese period '。' at end of descriptions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
ooooo-create
requested review from
Echo-Nie,
jzhang533,
mattheliu and
sunzhongkai588
as code owners
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7797.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 修复了 PaddlePaddle 中文 API 文档中不符合标点/分隔符规范的写法，提升中文文档的排版一致性与可读性。
Changes:
- 将参数说明中的英文冒号分隔符
:统一为-。 - 将英文句号
.、英文冒号:等替换为中文标点（如。、：），并规范部分枚举/逗号的写法。 - 统一/修正若干处中英文混排下的标点细节，减少风格不一致。
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/api/paddle/incubate/nn/functional/fused_dropout_add_cn.rst | 规范参数列表分隔符与中文标点（含默认值与类型描述）。 |
| docs/api/paddle/incubate/nn/FusedDropoutAdd_cn.rst | 规范参数说明分隔符与中文标点，并修正形状描述的句末标点。 |
| docs/api/paddle/distributed/stream/alltoall_single_cn.rst | 将参数分隔符从 : 调整为 -，与同文件其余参数风格对齐。 |
Comments suppressed due to low confidence (2)
docs/api/paddle/incubate/nn/FusedDropoutAdd_cn.rst:13
mode参数的可选值列表中|两侧没有空格（（默认）| 'downscale_in_infer'），与仓库中常见写法（例如 docs/api/paddle/incubate/nn/functional/fused_multi_transformer_cn.rst:75 的... (默认) | ...）不一致，且会降低可读性。建议在|两侧补空格，或改用“或”来分隔两个选项。
- **mode** (str，可选) - ['upscale_in_train'（默认）| 'downscale_in_infer']
docs/api/paddle/incubate/nn/functional/fused_dropout_add_cn.rst:16
mode参数可选值列表里使用了（默认）| 'downscale_in_infer'，|两侧缺少空格，阅读性较差，也与仓库内多处写法不一致（例如 docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst:26 使用... (默认) | ...）。建议统一为（默认） |（或用“或”替代|）以保持一致。
- **mode** (str，可选) - ['upscale_in_train'（默认）| 'downscale_in_infer']。
Echo-Nie
approved these changes
Feb 28, 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 standard violations in 3 Chinese API documentation files.
Changes
Issue: English punctuation used in Chinese API documentation
The following files used English punctuation where Chinese punctuation is required by the documentation standards:
docs/api/paddle/distributed/stream/alltoall_single_cn.rst(Tensor): description→(Tensor) - descriptionfor 4 parameters:, others-) made the file inconsistentdocs/api/paddle/incubate/nn/FusedDropoutAdd_cn.rst:→-in parameter descriptions,→,in type annotations like(float|int, 可选)→(float|int,可选).→。in shape descriptions(默认)→(默认)默认值: 0.5→默认值:0.5docs/api/paddle/incubate/nn/functional/fused_dropout_add_cn.rst:→-in all parameter descriptions,→,in type annotations、.→。at end of descriptionsStandards Compliance
These changes follow the documentation standards that specify:
-(dash) not:(colon),