Skip to content

[Docs] Batch fix remaining single-backtick inline literals (Batch 5)#7873

Merged
ooooo-create merged 3 commits intoPaddlePaddle:developfrom
StatefulDust:fix/inline-backticks-api-batch5-clean
Mar 17, 2026
Merged

[Docs] Batch fix remaining single-backtick inline literals (Batch 5)#7873
ooooo-create merged 3 commits intoPaddlePaddle:developfrom
StatefulDust:fix/inline-backticks-api-batch5-clean

Conversation

@cutetocute
Copy link
Contributor

PR types

Docs

PR changes

APIs

Description

This PR addresses remaining invalid single-backtick inline literals in the API Chinese documentation (Batch 5).

  • Fixed a bug in the checking script where document underline titles (like :::::::::) were incorrectly parsed as literal block marks (::), which uncovered 154 masked files containing outdated single-backticks.
  • Systematically fixed all these files with dynamic bounds checking: carefully avoided creating incorrect double spaces around CJK contexts, cleanly replacing instances like 包含data数据 with 包含 ``data`` 数据, preserving proper literal wrapping for API docs.
  • Ignored comments inside .rst comment blocks (e.g. docs/index_cn.rst) to keep the diff clean.

Zero remaining single backtick formatting violations in API document sections detected.

Tracked by StatefulDust#40

@paddle-bot
Copy link

paddle-bot bot commented Mar 16, 2026

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

@github-actions
Copy link

github-actions bot commented Mar 16, 2026

📚 本次 PR 文档预览链接(点击展开)
ℹ️ 预览提醒
请等待 Docs-NEW 流水线运行完成后再点击预览链接,否则可能会看到旧版本内容或遇到链接无法访问的情况。

Copy link
Collaborator

@ooooo-create ooooo-create left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

需要解决合并冲突,然后把 allclosepixel_shufflepaddle/static/Program 这几个 api 对应的文件修改恢复

@cutetocute
Copy link
Contributor Author

已解决合并冲突,并恢复了 allclosepixel_shufflepaddle/static/Program 等 API 文档的修改。

@ooooo-create ooooo-create merged commit 3aadf0d into PaddlePaddle:develop Mar 17, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants