[Docs] Fix English comma punctuation in Chinese API documentation#7814
Conversation
Replace English commas with Chinese commas(,)in Chinese API documentation for three files, following the documentation standard that states Chinese documents should use Chinese punctuation symbols, not English ones. Files fixed: - docs/api/paddle/nanquantile_cn.rst: Fix English comma in description - docs/api/paddle/random__cn.rst: Fix English comma in parameter description - docs/api/paddle/nn/functional/scaled_dot_product_attention_cn.rst: Fix multiple English commas in description and parameter definitions Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7814.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
There was a problem hiding this comment.
Pull request overview
该 PR 旨在按仓库中文文档规范,修复中文 API 文档中英文标点(主要是逗号)带来的排版与一致性问题,提升 Sphinx 文档渲染质量与可读性。
Changes:
- 将中文 API 文档中的英文逗号
,替换为中文逗号,,并去除不必要的标点后空格。 - 统一部分参数描述中的逗号用法(如 “默认值为” 等句式)。
- 修正部分段落的中文标点风格(如 “其中,”、“欲了解更多信息, 请参阅” 等)。
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/api/paddle/nanquantile_cn.rst | 将分隔逗号改为中文逗号,改善中文标点一致性。 |
| docs/api/paddle/random__cn.rst | 将参数说明中的英文逗号改为中文逗号。 |
| docs/api/paddle/nn/functional/scaled_dot_product_attention_cn.rst | 批量替换英文逗号为中文逗号并清理逗号后的空格,提升中文排版一致性。 |
| .. py:function:: paddle.nanquantile(x, q, axis=None, keepdim=False, interpolation='linear', name=None) | ||
|
|
||
| 沿给定的轴 ``axis`` 计算 ``x`` 中元素的分位数, 忽略元素中的 ``NaN`` 。 | ||
| 沿给定的轴 ``axis`` 计算 ``x`` 中元素的分位数,忽略元素中的 ``NaN`` 。 |
There was a problem hiding this comment.
“NaN” 后面的中文句号前多了一个空格(“NaN 。”),中文排版通常不应在标点前留空格;建议去掉该空格。
| 沿给定的轴 ``axis`` 计算 ``x`` 中元素的分位数,忽略元素中的 ``NaN`` 。 | |
| 沿给定的轴 ``axis`` 计算 ``x`` 中元素的分位数,忽略元素中的 ``NaN``。 |
| - **query** (Tensor) - 注意力模块中的查询张量。具有以下形状的四维张量:[batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float61 或 bfloat16。 | ||
| - **key** (Tensor) - 注意力模块中的关键张量。具有以下形状的四维张量:[batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float61 或 bfloat16。 | ||
| - **value** (Tensor) - 注意力模块中的值张量。具有以下形状的四维张量: [batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float61 或 bfloat16。 |
There was a problem hiding this comment.
参数说明里的数据类型写成了 “float61”,与上方 warning(float16/bfloat16)以及返回值描述不一致,应该是 “float16” 的笔误;建议统一为 float16。
| - **query** (Tensor) - 注意力模块中的查询张量。具有以下形状的四维张量:[batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float61 或 bfloat16。 | |
| - **key** (Tensor) - 注意力模块中的关键张量。具有以下形状的四维张量:[batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float61 或 bfloat16。 | |
| - **value** (Tensor) - 注意力模块中的值张量。具有以下形状的四维张量: [batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float61 或 bfloat16。 | |
| - **query** (Tensor) - 注意力模块中的查询张量。具有以下形状的四维张量:[batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float16 或 bfloat16。 | |
| - **key** (Tensor) - 注意力模块中的关键张量。具有以下形状的四维张量:[batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float16 或 bfloat16。 | |
| - **value** (Tensor) - 注意力模块中的值张量。具有以下形状的四维张量: [batch_size, seq_len, num_heads, head_dim],或者三维张量:[seq_len, num_heads, head_dim]。数据类型可以是 float16 或 bfloat16。 |
| - **attn_mask** (Tensor,可选) - 与添加到注意力分数的 ``query``、 ``key``、 ``value`` 类型相同的浮点掩码,默认值为空。 | ||
| - **dropout_p** (float) - ``dropout`` 的比例,默认值为 0.00 即不进行正则化。 | ||
| - **is_causal** (bool) - 是否启用因果关系,默认值为 False 即不启用。 | ||
| - **training** (bool): - 是否处于训练阶段,默认值为 True 即处于训练阶段。 |
There was a problem hiding this comment.
参数列表里 “training (bool): -” 的 “(bool)” 后多了一个冒号,和同段其它参数的写法不一致,也可能影响 Sphinx 渲染;建议改为与其它条目一致的 “training (bool) - ...”。
| - **training** (bool): - 是否处于训练阶段,默认值为 True 即处于训练阶段。 | |
| - **training** (bool) - 是否处于训练阶段,默认值为 True 即处于训练阶段。 |
| @@ -15,7 +15,7 @@ random_ 为 Inplace 版本实现,对输入 `x` 采用 Inplace 策略。 | |||
| - **x** (Tensor) - 输入多维 Tensor,可选的数据类型为 'int32'、'int64'、'float32'、'float64'、'float16'、'bfloat16'。 | |||
| - **from** (int,可选) - 生成随机值的范围下限,默认为 0。。 | |||
There was a problem hiding this comment.
这里的默认值描述末尾出现了重复句号(“0。。”),会影响文档质量;建议改为单个中文句号“0。”。
| - **from** (int,可选) - 生成随机值的范围下限,默认为 0。。 | |
| - **from** (int,可选) - 生成随机值的范围下限,默认为 0。 |
Summary
Fixed Chinese punctuation violations in 3 API documentation files. According to the repository's documentation standards, Chinese documents should use Chinese punctuation symbols (,。()etc.) instead of English ones (, . () etc.).
Files Changed
docs/api/paddle/nanquantile_cn.rst, 忽略元素中的→,忽略元素中的docs/api/paddle/random__cn.rst占位参数,当前未实现→占位参数,当前未实现docs/api/paddle/nn/functional/scaled_dot_product_attention_cn.rst其中,→其中,(Tensor, 可选)→(Tensor,可选), 默认值为→,默认值为(str, 可选)→(str,可选)欲了解更多信息, 请参阅→欲了解更多信息,请参阅Documentation Standard Reference
Per
.github/copilot-instructions.md:Translation: Chinese documents should avoid English punctuation marks (commas, periods, quotation marks, etc.) and should use Chinese punctuation marks instead.