-
Notifications
You must be signed in to change notification settings - Fork 5.7k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
[Docathon] 英文文档格式修复(Fix 'System Message') #58237
Labels
HappyOpenSource
快乐开源活动issue与PR
Comments
【报名】: 2 |
【报名】: 1、26 |
【报名】: 7、11、25、28 |
【报名】:4-8 |
【报名】: 3、9-11、14-15、25 |
【报名】: 22 |
【报名】: 12-14 |
【报名】: 23、24、27 |
This was referenced Nov 6, 2023
This was referenced Dec 5, 2023
[Docathon] 英文文档格式修复(Fix 'System Message') 已全部完成,感谢参与的小伙伴们!
|
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
背景
由于检查英文文档的CI在一段时间内失效,导致部分不合规的 PR 合入,从而产生了一些文档显示的问题。其中,比较突出的问题是「由格式问题导致文档内容解析错误」,表现为文档内容中出现 「System Message: Warning / Error」。
Example:
以 batch_norm 为例,在参数描述中出现 [System Message:Warning], 如下图所示:

在源码中,对应描述为:
实际上,由于 RST 语法的要求,同一段落缩进必须相同,因此修改为
Important
同一段落缩进不一致
、不同段落间没用空行相隔
、code_block下没加空行
等,英文文档格式务必参考 英文模板。任务描述
我们提供以下存在 System Message:Warning/Error 问题的文档,请在该 issue 回复序号进行认领,并在相应的源码中进行修改
@Sekiro-x
10distributed/fleet/MultiSlotStringDataGenerator_en@BernieHuang2008
@ooooo-create
@ooooo-create
@liyongchao911
24Tensor/fill_diagonal__en@BernieHuang2008
Note
1. Issue 回复格式:
为了自动填写报名信息,需要在issue下回复报名信息,如果报名格式不正确,则会在comment区提示报名不正确,格式如下:
Note
2. PR 标题格式:
PR的标题中以
[Docathon][Fix System Message No.xxxx]
开头即可,程序会自动提取赛题编号并更新榜单。一个PR也可以提交多个赛题,多个赛题间以
顿号
或横线
分隔,比如 No.24、26-28、30 赛题。看板信息
统计信息
The text was updated successfully, but these errors were encountered: