Skip to content
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

Refine documentation #229

Merged
merged 10 commits into from
Apr 7, 2022
Merged

Conversation

khloe-zhang
Copy link
Contributor

@khloe-zhang khloe-zhang commented Mar 28, 2022

  1. refine了Tutorials里的所有文档,剩下API文档还没有refine
  2. refine过程中遇到的共性问题:
  • 开发者的自我称呼:在文档中看到很多“we”用来指代开发者,显得不太客观。解决方法:

    • 尽量用“LiBai”来代替“we”,如:In LiBai, we define a standard set of config namespaces 改为 LiBai defines a standard set of config namespaces
    • 改用物做主语,如:We will introduce it in detail as follows 改为 The details are as follows
  • 对用户的称呼前后不一致:有user,有you,还有we。解决方法:

    • 建议统一称呼方式,这次refine里都修改成了you。

    注意:在指导用户操作时不要用we。中文里习惯说“我们可以这样做”,但英文里面“We can do...”可能会迷惑读者,没有指明到底是想让谁这样做。建议直接用“You can do...”。

  • 标签格式前后不一致:“note”和“step”在不同的文档里面格式不同,有 Note 和 NOTE,1. 和 Step 1.

    • 统一用 Note 和 Step 1.

@khloe-zhang khloe-zhang marked this pull request as ready for review April 1, 2022 06:46
khloe-zhang and others added 2 commits April 2, 2022 15:19
Co-authored-by: Ren Tianhe <48727989+rentainhe@users.noreply.github.com>
@rentainhe rentainhe added guide documentation Improvements or additions to documentation labels Apr 7, 2022
@rentainhe rentainhe mentioned this pull request Apr 7, 2022
@rentainhe rentainhe merged commit 7c2dd15 into Oneflow-Inc:main Apr 7, 2022
@khloe-zhang khloe-zhang deleted the refine-documentation branch April 18, 2022 03:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants