Skip to content

[Docs] Fix typos and formatting issues in cummax, cummin, and diag API docs#7786

Merged
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-typos-20260228-052031-5f32b0473099c526
Feb 28, 2026
Merged

[Docs] Fix typos and formatting issues in cummax, cummin, and diag API docs#7786
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom
StatefulDust:fix/api-docs-typos-20260228-052031-5f32b0473099c526

Conversation

@ooooo-create
Copy link
Collaborator

Summary

Fixed documentation compliance issues in 3 API doc files under docs/api/paddle/.

Changes

docs/api/paddle/cummax_cn.rst

  • Fixed duplicate 的的 (redundant character) typo in the indices return value description: 操作的的索引结果操作的索引结果

docs/api/paddle/cummin_cn.rst

  • Fixed duplicate 的的 (redundant character) typo in the indices return value description: 操作的的索引结果操作的索引结果
  • Added missing blank line before 返回 section (required for proper RST formatting)

docs/api/paddle/diag_cn.rst

  • Fixed missing space after - in padding_value parameter description: (int|float,可选) -使用此值(int|float,可选) - 使用此值

Standards Compliance

These fixes address violations of the documentation formatting standards:

  • Chinese text should use consistent formatting with proper spacing around punctuation
  • RST sections require proper blank lines between them
  • Parameter descriptions should follow the (type,可选) - description format consistently

Generated by API Docs Checker


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

- docs/api/paddle/cummax_cn.rst: Fix duplicate '的的' typo in indices return description
- docs/api/paddle/cummin_cn.rst: Fix duplicate '的的' typo in indices return description; add missing blank line before 返回 section
- docs/api/paddle/diag_cn.rst: Fix missing space after '-' in padding_value parameter description

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

paddle-bot bot commented Feb 28, 2026

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

@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

This PR fixes minor typos and formatting issues across three Chinese API documentation files for PaddlePaddle. The changes are purely documentation corrections with no functional code impact.

Changes:

  • Fixed duplicate 的的 typo in cummax_cn.rst and cummin_cn.rst return value descriptions
  • Added a missing blank line before the 返回 section in cummin_cn.rst for proper RST structure
  • Fixed a missing space after - in the padding_value parameter description in diag_cn.rst

Reviewed changes

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

File Description
docs/api/paddle/cummax_cn.rst Removed duplicate character 的的 in indices return value description
docs/api/paddle/cummin_cn.rst Removed duplicate character 的的 in indices return value description; added blank line before 返回 section
docs/api/paddle/diag_cn.rst Added missing space after - in padding_value parameter description

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.

🤖

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