-
Notifications
You must be signed in to change notification settings - Fork 55
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
Refine documentation #229
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rentainhe
reviewed
Apr 2, 2022
Co-authored-by: Ren Tianhe <48727989+rentainhe@users.noreply.github.com>
rentainhe
approved these changes
Apr 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
开发者的自我称呼:在文档中看到很多“we”用来指代开发者,显得不太客观。解决方法:
对用户的称呼前后不一致:有user,有you,还有we。解决方法:
注意:在指导用户操作时不要用we。中文里习惯说“我们可以这样做”,但英文里面“We can do...”可能会迷惑读者,没有指明到底是想让谁这样做。建议直接用“You can do...”。
标签格式前后不一致:“note”和“step”在不同的文档里面格式不同,有 Note 和 NOTE,1. 和 Step 1.