[Docathon][Fix Doc Format No.51-53]add space after attr'' #7465
Conversation
|
|
|
修改一下标题，加一个简要描述如： |
jackson-119
changed the title
| - **norm_type** (float or int) - 所用 p-范数类型。可以是无穷范数的`inf`。 | ||
| - **error_if_nonfinite** (bool) - 如果为 True，且如果来自：attr:`parameters`的梯度的总范数为`nan`、`inf`或`-inf`，则抛出错误。 | ||
| - **error_if_nonfinite** (bool) - 如果为 True，且如果来自：attr:`parameters` 的梯度的总范数为`nan`、`inf`或`-inf`，则抛出错误。 | ||
|
|
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
已将attr前的中文冒号更改为英文冒号
There was a problem hiding this comment.
已将attr前的中文冒号更改为英文冒号
这里渲染成斜体了，应该也需要在`两边加空格
There was a problem hiding this comment.
这里还是存在 `` 这样的符号改成下面这样吧：
xxxxx的总范数为 `nan`、`inf` 或 `-inf`，则抛出错误。
问题在于
对于 `` 包裹的内容，前反引号的前面需要空格，后反引号的后面不需要空格，rst语法对于空格有严格要求~ 还麻烦修改一下
| - **norm_type** (float or int) - 所用 p-范数类型。可以是无穷范数的`inf`。 | ||
| - **error_if_nonfinite** (bool) - 如果为 True，且如果来自：attr:`parameters`的梯度的总范数为`nan`、`inf`或`-inf`，则抛出错误。 | ||
| - **error_if_nonfinite** (bool) - 如果为 True，且如果来自：attr:`parameters` 的梯度的总范数为`nan`、`inf`或`-inf`，则抛出错误。 | ||
|
|
There was a problem hiding this comment.
已将attr前的中文冒号更改为英文冒号
这里渲染成斜体了，应该也需要在`两边加空格
| - **norm_type** (float or int) - 所用 p-范数类型。可以是无穷范数的`inf`。 | ||
| - **error_if_nonfinite** (bool) - 如果为 True，且如果来自：attr:`parameters`的梯度的总范数为`nan`、`inf`或`-inf`，则抛出错误。 | ||
| - **error_if_nonfinite** (bool) - 如果为 True，且如果来自：attr:`parameters` 的梯度的总范数为`nan`、`inf`或`-inf`，则抛出错误。 | ||
|
|
There was a problem hiding this comment.
这里还是存在 `` 这样的符号改成下面这样吧：
xxxxx的总范数为 `nan`、`inf` 或 `-inf`，则抛出错误。
问题在于
对于 `` 包裹的内容，前反引号的前面需要空格，后反引号的后面不需要空格，rst语法对于空格有严格要求~ 还麻烦修改一下
| - **norm_type** (float or int) - 所用 p-范数类型。可以是无穷范数的`inf`。 | ||
| - **error_if_nonfinite** (bool) - 如果为 True，且如果来自：attr:`parameters`的梯度的总范数为`nan`、`inf`或`-inf`，则抛出错误。 | ||
| - **error_if_nonfinite** (bool) - 如果为 True，且如果来自 :attr:`parameters` 的梯度的总范数为`nan`、 `inf` 或`-inf`，则抛出错误。 | ||
|
|
There was a problem hiding this comment.
现在渲染如上图，“或”的前面也需要空格，加一下就没问题了...麻烦同学有时间的时候再改一下
总范数为 `nan`、`inf` 或 `-inf`，则抛出错误。
There was a problem hiding this comment.
或的前面不是有空格吗，不好意思，我没太明白，是要再加一个空格吗还是加在后面？
There was a problem hiding this comment.
|
LGTM, 等 #7462 revert之后可以合入 |
PR types
others
PR changes
Docs
Description
Fix :attr:`` in the document
issue:#7435
@Echo-Nie @sunzhongkai588