[Docs] Fix invalid single-backticks usage in API docs (Batch 3)#7871
Merged
ooooo-create merged 1 commit intoPaddlePaddle:developfrom Mar 13, 2026
Merged
Conversation
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7871.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
📚 本次 PR 文档预览链接（点击展开）
|
ooooo-create
requested review from
Echo-Nie,
jzhang533,
mattheliu,
ooooo-create and
sunzhongkai588
as code owners
ooooo-create
approved these changes
Mar 13, 2026
cutetocute
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
本 PR 主要对 PaddlePaddle 文档库中大量 .rst 文档的 inline literal 书写进行规范化（将不应作为链接/role 的单反引号标记改为双反引号 ...），以避免被 Sphinx 误解析；同时夹带少量排版/链接格式修正。
Changes:
- 批量将中文/英文
.rst文档中的参数名、类名、取值等 inline literal 统一改为使用双反引号...。 - 优化部分文档段落/列表的排版（例如参数列表缩进）。
- 修复个别外链在
.rst中缺少尾随_导致无法正确渲染为链接的问题。
Reviewed changes
Copilot reviewed 98 out of 98 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/guides/06_distributed_training/cluster_quick_start_fl_ps_cn.rst | 规范教程中的 inline literal（文件名/类名等）为 ... |
| docs/api/paddle/true_divide_cn.rst | 规范参数取值 inline literal 为 ... |
| docs/api/paddle/tril_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/t__cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/static/nn/group_norm_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/static/CompiledProgram_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/sparse/sqrt_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/sinh_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/sin_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/rad2deg_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/Overview_cn.rst | 规范表格描述中的参数名 inline literal 为 ... |
| docs/api/paddle/sparse/nn/ReLU6_cn.rst | 规范参数/算子名 inline literal 为 ... |
| docs/api/paddle/sparse/nn/ReLU_cn.rst | 规范参数/算子名 inline literal 为 ... |
| docs/api/paddle/sparse/nn/LeakyReLU_cn.rst | 规范参数/算子名 inline literal 为 ... |
| docs/api/paddle/sparse/nn/functional/relu6_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/nn/functional/relu_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/nn/functional/leaky_relu_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/neg_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/log1p_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/deg2rad_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/atanh_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/atan_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/asinh_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/asin_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sparse/abs_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/sinh_cn.rst | 规范取值范围 inline literal 为 ... |
| docs/api/paddle/signal/stft_cn.rst | 规范参数取值 inline literal 为 ... |
| docs/api/paddle/signal/istft_cn.rst | 规范参数名 inline literal 并调整参数列表缩进排版 |
| docs/api/paddle/scatter__cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/reshape_cn.rst | 规范方法名/示例 inline literal 为 ... |
| docs/api/paddle/poisson_cn.rst | 规范 inline literal（lambda/Tensor 等）为 ... |
| docs/api/paddle/Overview_cn.rst | 规范表格描述中的参数名 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/StepDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/NoamDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/LRScheduler_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/LinearLR_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/CyclicLR_cn.rst | 规范表达式/方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst | 规范方法调用 inline literal 为 ... |
| docs/api/paddle/optimizer/Adadelta_cn.rst | 修复外链 .rst 语法（补 _） |
| docs/api/paddle/not_equal_cn.rst | 规范运算符 inline literal 为 ... |
| docs/api/paddle/neg__cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/metric/Recall_cn.rst | 规范 inline literal 为 ...（参数说明） |
| docs/api/paddle/metric/Precision_cn.rst | 规范 inline literal 为 ...（参数说明） |
| docs/api/paddle/linalg/vecdot_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/linalg/triangular_solve_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/linalg/solve_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/linalg/Overview_cn.rst | 规范 inline literal（矩阵形状/符号）为 ... |
| docs/api/paddle/less_than_cn.rst | 规范运算符 inline literal 为 ... |
| docs/api/paddle/less_equal_cn.rst | 规范运算符 inline literal 为 ... |
| docs/api/paddle/less_cn.rst | 规范运算符 inline literal 为 ... |
| docs/api/paddle/ldexp_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/isposinf_cn.rst | 规范取值 inline literal 为 ... |
| docs/api/paddle/isneginf_cn.rst | 规范取值 inline literal 为 ... |
| docs/api/paddle/isnan_cn.rst | 规范取值 inline literal 为 ... |
| docs/api/paddle/isinf_cn.rst | 规范取值 inline literal 为 ... |
| docs/api/paddle/isfinite_cn.rst | 规范取值 inline literal 为 ... |
| docs/api/paddle/is_tensor_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/incubate/nn/FusedLinear_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/incubate/nn/functional/fused_multi_head_attention_cn.rst | 规范形状描述 inline literal 为 ... |
| docs/api/paddle/incubate/asp/reset_excluded_layers_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/incubate/asp/decorate_cn.rst | 规范类名 inline literal 为 ... |
| docs/api/paddle/heaviside_cn.rst | 规范返回类型 inline literal 为 ... |
| docs/api/paddle/greater_than_cn.rst | 规范运算符 inline literal 为 ... |
| docs/api/paddle/greater_equal_cn.rst | 规范运算符 inline literal 为 ... |
| docs/api/paddle/frac_cn.rst | 规范类型名 inline literal 为 ... |
| docs/api/paddle/fluid/Overview_cn.rst | 规范 namespace inline literal 为 ... |
| docs/api/paddle/fft/irfftn_cn.rst | 规范函数名 inline literal 为 ... |
| docs/api/paddle/equal_cn.rst | 规范运算符 inline literal 为 ... |
| docs/api/paddle/distribution/Normal_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/distribution/LKJCholesky_cn.rst | 规范取值 inline literal 为 ... |
| docs/api/paddle/distribution/Cauchy_cn.rst | 规范方法名 inline literal 为 ... |
| docs/api/paddle/distributed/spawn_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/distributed/shard_scaler_cn.rst | 规范返回类型 inline literal 为 ... |
| docs/api/paddle/distributed/parallelize_cn.rst | 规范返回类型 inline literal 为 ... |
| docs/api/paddle/distributed/fleet/UtilBase_cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/device/Overview_cn.rst | 规范模块名 inline literal 为 ... |
| docs/api/paddle/cosh_cn.rst | 规范取值范围 inline literal 为 ... |
| docs/api/paddle/cos_cn.rst | 规范取值范围 inline literal 为 ... |
| docs/api/paddle/binomial_cn.rst | 规范分布参数 inline literal 为 ... |
| docs/api/paddle/baddbmm__cn.rst | 规范参数名 inline literal 为 ... |
| docs/api/paddle/as_tensor_cn.rst | 规范别名 inline literal 为 ... |
| docs/api/paddle/amp/debugging/compare_accuracy_cn.rst | 规范工具名 inline literal 为 ... |
| docs/api/paddle/addmm__cn.rst | 规范参数名 inline literal 为 ... |
| docs/api_guides/low_level/parameter.rst | 规范 inline literal 为 ...（含 deprecated namespace） |
| docs/api_guides/low_level/parameter_en.rst | 规范 inline literal 为 ...（含 deprecated namespace） |
| docs/api_guides/low_level/optimizer.rst | 合并换行并保持外链标记正确渲染 |
| docs/api_guides/low_level/optimizer_en.rst | 合并换行并保持外链标记正确渲染 |
You can also share your feedback on Copilot code review. Take the survey.
| .. py:function:: paddle.neg_(x, name=None) | ||
|
|
||
| Inplace 版本的 :ref:`cn_api_paddle_neg` API，对输入 `input` 采用 Inplace 策略。 | ||
| Inplace 版本的 :ref:`cn_api_paddle_neg` API，对输入 ``input`` 采用 Inplace 策略。 |
|
|
||
|
|
||
| 重置与 `main_program` 对应的 excluded_layers 设置。如果 `main_program` 为 None，则 excepted_layers 的所有配置都将被清除。 | ||
| 重置与 ``main_program`` 对应的 excluded_layers 设置。如果 ``main_program`` 为 None，则 excepted_layers 的所有配置都将被清除。 |
|
|
||
|
|
||
| 相关矩阵的下三角 Choleskey 因子的 LJK 分布支持两种 sample 方法:`onion` 和 `cvine` | ||
| 相关矩阵的下三角 Choleskey 因子的 LJK 分布支持两种 sample 方法：``onion`` 和 ``cvine``。 |
|
|
||
|
|
||
| 返回 :math:`x>y` 逐元素比较 x 和 y 是否相等，相同位置前者输入大于等于后者输入则返回 True，否则返回 False。使用重载算子 `>` 可以有相同的计算函数效果。 | ||
| 返回 :math:`x>y` 逐元素比较 x 和 y 是否相等，相同位置前者输入大于等于后者输入则返回 True，否则返回 False。使用重载算子 ``>`` 可以有相同的计算函数效果。 |
| Model：一个具有分布式视角的 ``Model`` 对象。 | ||
|
|
||
| Optimizer：一个具有分布式视角的 `Optimizer` 对象。如果用户为提供优化器对象，则返回 None。 | ||
| Optimizer：一个具有分布式视角的 ``Optimizer`` 对象。如果用户为提供优化器对象，则返回 None。 |
| .. py:class:: paddle.sparse.nn.LeakyReLU(negative_slope=0.01, name=None) | ||
|
|
||
| 稀疏 LeakyReLU 激活层，创建一个可调用对象以计算输入 `x` 的 `LeakReLU` 。 | ||
| 稀疏 LeakyReLU 激活层，创建一个可调用对象以计算输入 ``x`` 的 ``LeakReLU`` 。 |
Echo-Nie
approved these changes
Mar 13, 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.
PR types
Typos
PR changes
Docs
Description
This PR continues to resolve the abuse of single backticks in RST documents as tracked in StatefulDust#40 .
The previous single-backticks used incorrectly for inline literals or variable names have been properly replaced with double backticks and appropriately formatted hyperlink roles.
This batch focuses on API docs in optimizer, sparse, distributions and several standard APIs avoiding intersections with other pending PRs.