[Docs] Fix typo and RST inline code formatting in API docs#7799
Merged
SigureMo merged 1 commit intoPaddlePaddle:developfrom Feb 28, 2026
Conversation
- Fix typo '两个个' -> '两个' in dstack_cn.rst - Fix missing space around '[1, 3]' in dstack_cn.rst - Fix single backtick to double backtick for inline code in segment_max_cn.rst - Fix single backtick to double backtick for inline code in segment_mean_cn.rst - Add missing spaces between Chinese text and inline code markers Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
ooooo-create
requested review from
Echo-Nie,
jzhang533,
mattheliu and
sunzhongkai588
as code owners
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7799.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
Contributor
There was a problem hiding this comment.
Pull request overview
该 PR 针对 PaddlePaddle 中文 API 文档（Sphinx/RST）做规范化修正，主要是修复错别字与行内“代码样式”/中英混排空格问题，以提升文档一致性与可读性。
Changes:
- 修复
dstack文档中的重复字与形状描述缺失空格问题。 - 将
segment_mean/segment_max参数说明中的行内引用从单反引号调整为 RST 字面量写法（双反引号），并补齐与中文之间的空格。
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/api/paddle/dstack_cn.rst | 修复“两个个形状”笔误，并规范形状描述的空格排版 |
| docs/api/paddle/incubate/segment_max_cn.rst | 规范 segment_ids 参数行内字面量标记与中英/代码间空格 |
| docs/api/paddle/incubate/segment_mean_cn.rst | 规范 segment_ids 参数行内字面量标记与中英/代码间空格 |
Echo-Nie
approved these changes
Feb 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
This PR fixes documentation standard violations found in 3 API doc files:
1.
docs/api/paddle/dstack_cn.rst两个个形状→两个形状(duplicate character)[1, 3]shape notation:形状为[1, 3]的→形状为 [1, 3] 的2.
docs/api/paddle/incubate/segment_max_cn.rst`data`→ double backtick``data``(RST standard)3.
docs/api/paddle/incubate/segment_mean_cn.rstsegment_max_cn.rst: single backtick → double backtick for inline codeStandards Applied
Per the repository's documentation standards (
.github/copilot-instructions.md):``) for inline code, not single backticks