-
Notifications
You must be signed in to change notification settings - Fork 760
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docathon] 中文文档 copy-from 清理 #6300
Labels
HappyOpenSource
快乐开源活动issue与PR
PFCC
Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
Comments
paddle-bot
bot
added
the
PFCC
Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
label
Nov 8, 2023
This was referenced Nov 9, 2023
【报名】: 1、2、3 |
【报名】: 6-10 |
【报名】: 11-15 |
【报名】: 4、5 |
【报名】: 16-19 |
This was referenced Nov 22, 2023
This was referenced Nov 24, 2023
This was referenced Dec 5, 2023
This was referenced Dec 10, 2023
[Docathon] 中文文档 copy-from 清理 已全部完成,感谢参与的小伙伴们!
|
github-project-automation
bot
moved this from In Progress
to Done
in Call for Contributions
Dec 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
HappyOpenSource
快乐开源活动issue与PR
PFCC
Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
背景
为了使中、英文 API 文档的示例代码保持一致,飞桨中文 API 文档使用
COPY-FROM
来直接引用英文的 API 示例代码。但是,目前中文 API 文档中还存在一些
COPY-FROM
不成功的情况,表现形式为无法显示代码示例,例如 Conll05st原因分析
一般无法正确显示代码示例,会分为 2 种情况:中文文档的 COPY-FROM 引用方式写法存在错误,或者是被引用的英文文档的示例代码写法存在错误。
1. COPY-FROM 后面的
API 名称或路径
不正确。以 Conll05st 为例,COPY-FROM 后面的路径为
paddle.text.datasets.Conll05st
,但实际的 API 路径为paddle.text.Conll05st
(可以直接看官网左侧 API 的目录来确定路径)Important
正确的引用方式可以参考:中文API文档复制英文API文档示例代码。
需要注意的是其中
api_name
为该 API 的公开路径
,英文官网 api 文档中展示的就是所有公开的 API。2. 被 COPY-FROM 的 API 没有规范的书写格式
典型场景为英文文档的示例代码缺少空行,如
:name: code_id
标识符之后没有空行,以 distributed.Fleet 为例。.. code-block:: python
之后没有空行 (在不需要 name: code_id 标识符时)docs/docs/api/paddle/distributed/fleet/Fleet_cn.rst
Lines 683 to 688 in f311fe4
任务描述
@Liyulingyue #6304
任务认领
Note
1. Issue 回复格式:
为了自动填写报名信息,需要在issue下回复报名信息,如果报名格式不正确,则会在comment区提示报名不正确,格式如下:
Note
2. PR 标题格式:
PR的标题中以
[Docathon][Fix COPY-FROM No.xxxx]
开头即可,程序会自动提取赛题编号并更新榜单。一个PR也可以提交多个赛题,多个赛题间以
顿号
或横线
分隔,比如 No.24、26-28、30 赛题。Note
3. PR 内容:
需要描述修改的文件、附上活动 issue 链接、 并 @ooooo-create @sunzhongkai588
看板信息
统计信息
The text was updated successfully, but these errors were encountered: