-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Closed
Labels
HappyOpenSource快乐开源活动issue与PR快乐开源活动issue与PR
Description
背景
由于检查英文文档的CI在一段时间内失效,导致部分不合规的 PR 合入,从而产生了一些文档显示的问题。其中,比较突出的问题是「由格式问题导致文档内容解析错误」,表现为文档内容中出现 「System Message: Warning / Error」。
Example:
以 batch_norm 为例,在参数描述中出现 [System Message:Warning], 如下图所示:
在源码中,对应描述为:
param_attr(ParamAttr|None): The parameter attribute for Parameter `scale`
of batch_norm. If it is set to None or one attribute of ParamAttr, batch_norm
will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
If the Initializer of the param_attr is not set, the parameter is initialized
with Xavier. Default: None.
实际上,由于 RST 语法的要求,同一段落缩进必须相同,因此修改为
param_attr(ParamAttr|None): The parameter attribute for Parameter `scale`
of batch_norm. If it is set to None or one attribute of ParamAttr, batch_norm
will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
If the Initializer of the param_attr is not set, the parameter is initialized
with Xavier. Default: None.
Important
- 一般出现 System Message:Warning/Error 的问题,往往是由于
同一段落缩进不一致
、不同段落间没用空行相隔
、code_block下没加空行
等,英文文档格式务必参考 英文模板。 - 同时,想了解更多 RST 语法,可参考 reStructuredText Primer
任务描述
我们提供以下存在 System Message:Warning/Error 问题的文档,请在该 issue 回复序号进行认领,并在相应的源码中进行修改
Note
1. Issue 回复格式:
为了自动填写报名信息,需要在issue下回复报名信息,如果报名格式不正确,则会在comment区提示报名不正确,格式如下:
【报名】: 2、3、6-10
其中【报名】: 后直接是报名的赛题序号,多个赛题之间需要用中文顿号
、
分隔,多个连续赛题可以用横线
表示
Note
2. PR 标题格式:
[Docathon][Fix System Message No.2、3、6-10]
PR的标题中以 [Docathon][Fix System Message No.xxxx]
开头即可,程序会自动提取赛题编号并更新榜单。
一个PR也可以提交多个赛题,多个赛题间以顿号
或横线
分隔,比如 No.24、26-28、30 赛题。
看板信息
任务方向 | 任务数量 | 提交作品 / 任务认领 | 提交率 | 完成 | 完成率 |
---|---|---|---|---|---|
Docathon | 28 | 24 / 24 | 85.71% | 24 | 85.71% |
统计信息
排名不分先后 @BernieHuang2008 (6) @ooooo-create (3) @Tomoko-hjf (4) @Sekiro-x (6) @Liyulingyue (4) @wenxiaohahaha (1)
Metadata
Metadata
Assignees
Labels
HappyOpenSource快乐开源活动issue与PR快乐开源活动issue与PR
Type
Projects
Status
Done