Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.55 KB

---document-issue-.md

File metadata and controls

59 lines (39 loc) · 2.55 KB
Raw
name about
文档（Document Issue）
您可以提问文档相关的问题。 You could use this template for reporting an document issue.

非常感谢您提交关于飞桨文档的Issue，我们会认真听取您的意见，并进行改进。

建立issue时，为快速解决问题，请您根据情况给出如下信息：

  • 标题：请包含关键词“XXX文档问题”，例如“add 文档问题” 或 ”paddle.add 文档问题“
  • 文档版本信息：请提供有问题的文档的版本号，例如 develop，1.8，2.0RC；

文档问题描述：

API文档描述是否清晰？

如：文档描述看不懂，不知道这个API该怎么用；文档公式错误；

参数说明是否清晰

如：参数未解释清楚，包括用法、使用场景、默认值等

返回/形状说明是否清晰

如：API返回值、数据的形状描述错误、不清楚

示例代码是否有效？

如：没有示例代码；示例代码没有可指导性；示例代码跑不通；示例代码格式有问题；示例代码没有注释；

中英文内容是否一致？

如：中英文API描述不一致；中英文API参数不一致；

其他

如：文档页面打不开；文档缺失；文档中有死链；

Thanks for opening a document issue. We will listen to your opinions carefully and make improvements.

In order to quickly solve your problem, when creating an issue, please provide the following information: Document Information

  • Title：Please include the keyword "XXX document issue", such as "add document issue" or "paddle.add document issue"
  • Doc Version：Please provide the version of the document, such as develop, 1.8, 2.0RC;

Describe the problem：

Document description is clear?

For example: I don’t understand this document, I don’t know how to use this API; The formula in this doc is unclear;

Parameter description is clear?

For example: The parameters are confusing, including usage, scenarios, default values, etc.

Return/Shape description is clear

For example: Data returned this doc is error, shape returned is not clear.

The sample code is clear?

For example: no sample code; The sample code is not helpful; The sample code not run well; Format of the sample is not reasonable; The sample code has no comments.

Chinese content and English content is consistent?

For example:Chinese API in this doc is inconsistent with English API, including params, description, sample code, formula, etc.

Other

For example: The doc link is broken; The doc page is missing; Dead link in docs.