Python API注释优化需求
Created by: shanyi15
背景:
PM文档方向于近期走查了Paddle API Reference文档(基于v1.1),总结共计78个python api注释中存在以下问题:
1) 文字描述较少、抽象,很难理解 2) 参数说明错误或不齐全 3) 代码示例错误或不齐全 4) 格式混乱
其中代码示例错误和格式混乱的问题共计42个,将由PM进行修复 剩余问题总结如下,辛苦研发老师支持修复
由于API文档对用户使用体验影响较大,我们将提升此项工作的优先级,期望在v1.2前修复,并随v1.2上线
需要研发老师支持修复的API注释
-
没有文档内容
-
参数说明不完整,缺少代码示例
-
block中的 class docstring 是否写错了呢
-
'elu','relu6','pow','stanh','hard_sigmoid','swish', 'prelu','brelu','leaky_relu','soft_relu'
这些API,缺少代码示例
-
这些API,缺少代码示例
-
缺少代码示例