[docs] fix some api docs style #7525
Conversation
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7525.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
ci_scripts/report_preview_url.sh
Outdated
| if [ ${#output_lines[@]} -gt 0 ]; then | ||
| cat <<-EOF | ||
| > [!CAUTION] | ||
| > 如果你不清楚这个 pr 的修改内容（特别是修改了 \`report_preview_url.sh\` 或 \`preview-url-generate.yml\`），请不要随便点击链接！！！ |
There was a problem hiding this comment.
不过是不是要提示等渲染流水线跑完上传完再看，不然可能是旧的
哦对，这个用 NOTE 可以吧
这里是想说什么呢？加一个 CAUTION 感觉很奇怪
因为之前搞了实时查看和验证被更新过的 report_preview_url 的功能，怕有人 pr 搞了恶意链接别人不知道点了，其实我也不想加这个（doge，我准备把这个删了，因为我加的这个别人也能改掉_(:з」∠)_，我相信他们不会乱点，不然只能用 pull_request_target 舍弃这个实时功能了，或者修改了这两个文件的只能 approve 之后才能跑
突然又想到那个 mac 流水线，我改了一个 cmake 就影响物理机器了，别人是不是也可以下载了病毒啥的，哦对，好像陌生 id 需要 approve 才能运行流水线
There was a problem hiding this comment.
修改移到这个 pr 里啦 #7528
SigureMo
requested review from
jzhang533,
mattheliu and
sunzhongkai588
as code owners
| :::::::::::: | ||
|
|
||
| - **x** (Tensor) - 输入一个或一批矩阵。``x`` 的形状应为 ``[*, M, M]``，数据类型支持 float32、float64、complex64 和 complex128。 | ||
| - **x** (Tensor) - 输入一个或一批矩阵。``x`` 的形状应为 ``[*, M, M]``，数据类型支持 float32、float64、complex64 或 complex128。 |
There was a problem hiding this comment.
这里是不是就应该是「和」？@sunzhongkai588
有..什么区别嘛
There was a problem hiding this comment.
严谨来说可能‘或’更好些。‘和’可能会被理解成： [f32，f64，c64 和 c128]，‘或’就是[f32，f64，c64，c128]；不过感觉无伤大雅....
There was a problem hiding this comment.
噢噢，当时没仔细看，直接替换的。当时就是因为没什么区别才改的，本来想统一一下描述输入类型的写法（结果没仔细看句子）。现在让我新增 api 文档我肯定就是复制其他的改，复制不同的写法可能就不同，其实不改也没关系，当时只是为了测试 ci
5 participants
No description provided.