docs: fix remaining single-backtick literals in allclose and pixel_shuffle#7879
Merged
luotao1 merged 2 commits intoPaddlePaddle:developfrom Mar 24, 2026
Conversation
cutetocute
requested review from
Echo-Nie,
jzhang533,
mattheliu,
ooooo-create and
sunzhongkai588
as code owners
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7879.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
Echo-Nie
approved these changes
Mar 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
该 PR 作为 #7873 的后续修复，继续清理中文 API 文档中 allclose 与 pixel_shuffle 里残留的单反引号行内字面量，避免被 Sphinx 误解析为 role/链接，从而提升渲染一致性与规范性。
Changes:
- 将
pixel_shuffle中文文档中的Class、shape/维度符号等单反引号行内字面量替换为双反引号...。 - 将
allclose中文文档参数描述中Tensor的单反引号替换为双反引号...。
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/api/paddle/nn/functional/pixel_shuffle_cn.rst | 修复 note/参数段落中残留的单反引号 inline literal 为 ... |
| docs/api/paddle/allclose_cn.rst | 修复参数描述中 Tensor 的单反引号为 Tensor |
Echo-Nie
approved these changes
Mar 23, 2026
cutetocute
commented
Mar 24, 2026
Collaborator
|
@luotao1 涛姐，这个 pr 没法过 CI，强合一下叭 |
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.
PR 类型
DOCS
PR 范围
APIs
主要内容
修复
allclose和pixel_shuffleAPI 中文文档中剩余的单反引号行内字面量问题。这是 #7873 的后续 PR，根据审查意见修复之前恢复的两个 API 文档。
修改文件
docs/api/paddle/allclose_cn.rstdocs/api/paddle/nn/functional/pixel_shuffle_cn.rst修复内容
将单反引号行内字面量改为双反引号：
Tensor→TensorClass→Class[N, C, H, W]→[N, C, H, W]预览链接
待构建