Skip to content

[Docs] Fix punctuation and typo issues in API docs (floor, irfft, full)#7808

Merged
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-punctuation-typo-20260228151309-8b8d7b257cb8cc48
Mar 1, 2026
Merged

[Docs] Fix punctuation and typo issues in API docs (floor, irfft, full)#7808
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-punctuation-typo-20260228151309-8b8d7b257cb8cc48

Conversation

@ooooo-create
Copy link
Collaborator

Changes

Fixed documentation standard violations in 3 API docs files:

1. docs/api/paddle/floor_cn.rst

  • Issue: English commas , used in Chinese text when listing data types
  • Fix: Replaced with Chinese enumeration marks to be consistent with other API docs (e.g., flip_cn.rst, flatten_cn.rst)
  • Before: float32, float64, float16, bfloat16, uint8, int8, int16, int32, int64
  • After: float32、float64、float16、bfloat16、uint8、int8、int16、int32、int64

2. docs/api/paddle/fft/irfft_cn.rst

  • Issue: English commas , used between norm value options in Chinese text
  • Fix: Replaced with Chinese enumeration marks to be consistent with similar files (e.g., irfftn_cn.rst)
  • Before: "forward", "backward", "ortho"
  • After: "forward"、"backward"、"ortho"

3. docs/api/paddle/full_cn.rst

  • Issue: Typo in parameter description — dytpe instead of dtype
  • Fix: Corrected the typo to dtype

Standards Reference

Per the documentation standards:

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

Generated by API Docs Checker


🔄 Synced from StatefulDust#17

- floor_cn.rst: Replace English commas with Chinese enumeration marks (、) in data type list
- fft/irfft_cn.rst: Replace English commas with Chinese enumeration marks (、) in norm values list
- full_cn.rst: Fix typo 'dytpe' -> 'dtype'

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-7808.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 聚焦于修复 PaddlePaddle 中文 API 文档(Sphinx / .rst)中的文档规范问题,主要是中文语境下的标点符号规范与参数说明拼写错误,以提升 API 文档一致性与可读性。

Changes:

  • 修复 paddle.full 参数说明中的拼写错误:dytpedtype
  • paddle.floor 参数说明中数据类型列表的英文逗号分隔改为中文顿号分隔
  • paddle.fft.irfft 参数说明中 norm 取值列举的英文逗号分隔改为中文顿号分隔

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/api/paddle/full_cn.rst 更正参数说明中的 dtype 拼写错误,避免误导读者。
docs/api/paddle/floor_cn.rst 将中文文档中的类型枚举分隔符改为中文顿号,符合中文标点规范。
docs/api/paddle/fft/irfft_cn.rst norm 选项列举分隔符改为中文顿号,保持中文文档风格一致。

@Echo-Nie Echo-Nie merged commit d06b679 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