[Docs] Fix formatting issues in API docs: en-dashes and RST inline code syntax#7796
Merged
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom Feb 28, 2026
Conversation
…ne code syntax - docs/api/paddle/distributed/reduce_scatter_cn.rst: Replace en-dash (–) with regular hyphen (-) in parameter descriptions for tensor and tensor_list params - docs/api/paddle/distributed/stream/reduce_scatter_cn.rst: Replace en-dash (–) with regular hyphen (-) in tensor parameter description - docs/api/paddle/fft/Overview_cn.rst: Fix single backtick to double backtick for inline code `X[(n+1)//2]` -> ``X[(n+1)//2]`` and add missing space before Chinese text Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7796.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 针对 docs/api/paddle/ 下的中文 API 文档进行小范围格式修复,主要解决 RST 行内代码与参数列表分隔符的排版一致性问题,以避免 Sphinx 渲染异常或风格不统一。
Changes:
- 将参数描述中的 en-dash(
–)统一替换为常规连字符(-),与同文件其余参数列表风格一致 - 修复 RST 行内代码标记:将单反引号改为双反引号(inline literal),并补齐代码后与中文之间的空格
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/api/paddle/fft/Overview_cn.rst | 修复一处行内代码从 interpreted text 改为 inline literal,并补齐代码与中文间空格 |
| docs/api/paddle/distributed/stream/reduce_scatter_cn.rst | 将参数列表分隔符由 en-dash 改为 -,与同页其余参数一致 |
| docs/api/paddle/distributed/reduce_scatter_cn.rst | 将 tensor/tensor_list 参数分隔符由 en-dash 改为 -,统一格式 |
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.
Summary
This PR fixes formatting issues found in 3 API documentation files under
docs/api/paddle/.Changes
1.
docs/api/paddle/distributed/reduce_scatter_cn.rst–, U+2013) with regular hyphen (-) in parameter descriptions fortensorandtensor_listparameters2.
docs/api/paddle/distributed/stream/reduce_scatter_cn.rst–, U+2013) with regular hyphen (-) in thetensorparameter description3.
docs/api/paddle/fft/Overview_cn.rst`X[(n+1)//2]`→X[(n+1)//2]X[(n-1)//2]), so this was an inconsistencyStandards Compliance
These fixes address violations of the documentation standards described in
.github/copilot-instructions.md: