[Docs] Fix missing blank line after .. py:function:: directive in RST files#7809
Merged
Echo-Nie merged 1 commit intoPaddlePaddle:developfrom Mar 1, 2026
Conversation
Add missing blank lines after '.. py:function::' directives in three inplace API documentation files. In ReStructuredText, a blank line is required between the directive header and its description content for proper parsing. Fixed files: - docs/api/paddle/gammainc__cn.rst - docs/api/paddle/gammaincc__cn.rst - docs/api/paddle/gcd__cn.rst Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7809.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 中文 inplace API 的 .rst 文档做语法格式修正,补齐 .. py:function:: 指令行与后续说明段落之间缺失的空行,以符合 ReStructuredText 的指令书写规范并避免潜在解析问题。
Changes:
- 为
gammainc_/gammaincc_/gcd_三个 inplace API 文档在.. py:function::后补充空行 - 使三处文档格式与同类 inplace API 文档保持一致
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/api/paddle/gcd__cn.rst | 在 .. py:function:: paddle.gcd_ 后补充空行,修复 RST 指令段落分隔 |
| docs/api/paddle/gammaincc__cn.rst | 在 .. py:function:: paddle.gammaincc_ 后补充空行,修复 RST 指令段落分隔 |
| docs/api/paddle/gammainc__cn.rst | 在 .. py:function:: paddle.gammainc_ 后补充空行,修复 RST 指令段落分隔 |
cutetocute
approved these changes
Mar 1, 2026
Echo-Nie
approved these changes
Mar 1, 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
Fixed missing blank lines after
.. py:function::directives in three inplace API documentation files.Problem
In ReStructuredText (RST) syntax, a blank line is required between a directive header and its description content for proper parsing. The following files were missing this blank line:
docs/api/paddle/gammainc__cn.rstdocs/api/paddle/gammaincc__cn.rstdocs/api/paddle/gcd__cn.rstBefore (non-compliant):
After (compliant):
Relevant Standard
From the documentation guidelines (
.github/copilot-instructions.md):This matches the formatting already used in similar inplace API docs such as
gammaln__cn.rstwhich correctly has a blank line after the directive.