Skip to content

[Docs] Fix typos and RST markup issues in paddle.cuda API docs#7788

Merged
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-cuda-issues-20260228065336-683fbb0ebd55dde7
Feb 28, 2026
Merged

[Docs] Fix typos and RST markup issues in paddle.cuda API docs#7788
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-cuda-issues-20260228065336-683fbb0ebd55dde7

Conversation

@ooooo-create
Copy link
Collaborator

Changes

Fixed documentation issues found in docs/api/paddle/cuda/ API documentation files.

Issues Fixed

  1. docs/api/paddle/cuda/manual_seed_cn.rst — Typo: missing character

    • Before: 为当前设备置随机种子
    • After: 为当前设备设置随机种子
  2. docs/api/paddle/cuda/device_cn.rst — Stray quote mark and missing RST inline code markup

    • Before: 如 npu:x',
    • After: 如 ``npu:x``,
  3. docs/api/paddle/cuda/reset_peak_memory_stats_cn.rst — Stray quote mark and missing RST inline code markup

    • Before: 如 npu:x',
    • After: 如 ``npu:x``,

Notes

  • The stray quote ' in device_cn.rst and reset_peak_memory_stats_cn.rst appears to be a copy-paste error. The correct format uses RST double-backtick markup ``npu:x`` to display inline code, consistent with how it appears in max_memory_allocated_cn.rst.
  • The missing in manual_seed_cn.rst is a character drop typo — the phrase 为当前设备置随机种子 is grammatically incomplete and should be 为当前设备设置随机种子.

Generated by API Docs Checker


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

- Fix missing character '设' in manual_seed_cn.rst: '为当前设备置随机种子' → '为当前设备设置随机种子'
- Fix stray quote and missing RST markup in device_cn.rst: 'npu:x'' → '``npu:x``'
- Fix stray quote and missing RST markup in reset_peak_memory_stats_cn.rst: 'npu:x'' → '``npu:x``'

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link

📚 本次 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 针对 docs/api/paddle/cuda/ 下的中文 API 文档进行小范围修订,修复拼写错误与 ReStructuredText(RST)行内代码标记问题,以提升文档可读性并避免渲染异常。

Changes:

  • 修复 manual_seed_cn.rst 中中文描述缺字导致的语病(“置”→“设置”)。
  • 修复 device_cn.rstreset_peak_memory_stats_cn.rst 中多余引号,并将示例 npu:x 改为 RST 行内字面量格式(npu:x)。
  • 顺带统一相关句子标点后的空格表现(如 “属性。如果 …”)。

Reviewed changes

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

File Description
docs/api/paddle/cuda/manual_seed_cn.rst 修复中文描述缺字导致的语义不完整问题
docs/api/paddle/cuda/device_cn.rst 修复多余引号并补充 RST 行内代码标记
docs/api/paddle/cuda/reset_peak_memory_stats_cn.rst 修复多余引号并补充 RST 行内代码标记

@paddle-bot
Copy link

paddle-bot bot commented Feb 28, 2026

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

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🤖

@Echo-Nie Echo-Nie merged commit 0478ea7 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.

4 participants