Skip to content

[Docs] Fix typos and English punctuation in Chinese API docs#7795

Merged
SigureMo merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-punctuation-and-typos-20260228-c859d370e99be0dd
Feb 28, 2026
Merged

[Docs] Fix typos and English punctuation in Chinese API docs#7795
SigureMo merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-punctuation-and-typos-20260228-c859d370e99be0dd

Conversation

@ooooo-create
Copy link
Collaborator

Summary

Fixed documentation compliance issues in 3 API doc files found during automated documentation standards check.

Changes

1. docs/api/paddle/distributed/QueueDataset_cn.rst

  • Fixed typo: QueueyDatasetQueueDataset (class name misspelling)
  • Fixed class name: InmemoryDatasetInMemoryDataset (incorrect capitalization)

2. docs/api/paddle/distributed/to_static_cn.rst

  • Fixed punctuation: replaced English comma , with Chinese comma , in Chinese prose (line 8)

3. docs/api/paddle/frexp_cn.rst

  • Fixed punctuation: replaced English comma , with Chinese comma , in Chinese prose (line 9)

Standards Reference

Per the documentation standards:

  • 中文文档中尽量避免使用英文标点符号,均应使用中文标点符号
  • Class and API names must be spelled correctly and consistently

Generated by API Docs Checker


🔄 Synced from https://github.com/StatefulDust/paddle-docs-agent/pull/12

- Fix typo 'QueueyDataset' -> 'QueueDataset' in QueueDataset_cn.rst
- Fix class name 'InmemoryDataset' -> 'InMemoryDataset' in QueueDataset_cn.rst
- Replace English comma with Chinese comma in to_static_cn.rst (line 8)
- Replace English comma with Chinese comma in frexp_cn.rst (line 9)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 28, 2026 14:06
@paddle-bot
Copy link

paddle-bot bot commented Feb 28, 2026

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

@github-actions
Copy link

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

Copy link
Collaborator

@Echo-Nie Echo-Nie left a comment

Choose a reason for hiding this comment

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

lgtm

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 文档做了合规性修复,主要解决自动化检查发现的拼写错误与中文标点使用不规范问题,以保证 API 名称一致性与中文行文规范。

Changes:

  • 修正 QueueDataset_cn.rst 中的类名拼写/大小写错误(QueueyDatasetQueueDatasetInmemoryDatasetInMemoryDataset
  • 修正 to_static_cn.rstfrexp_cn.rst 中文描述中的英文逗号为中文逗号(,

Reviewed changes

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

File Description
docs/api/paddle/distributed/QueueDataset_cn.rst 修正文档中类名拼写与大小写,保证与实际 API 名称一致。
docs/api/paddle/distributed/to_static_cn.rst 将中文段落中的英文逗号替换为中文逗号,符合中文标点规范。
docs/api/paddle/frexp_cn.rst 将中文段落中的英文逗号替换为中文逗号,符合中文标点规范。

Copy link
Member

@SigureMo SigureMo left a comment

Choose a reason for hiding this comment

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

LGTMeow 🐾

@SigureMo SigureMo merged commit 2c96b5d into PaddlePaddle:develop Feb 28, 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.

5 participants