-
Notifications
You must be signed in to change notification settings - Fork 520
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
Unify the comment style. #3807
Comments
Hey I want to work on this issue, it would be great if anyone assign this to me! |
Thanks for raising this but I don't have interest to review PRs that just polishes comment styles. PRs for detailed behavior corrections are welcome. We can process them in separate issues instead. |
Ok thanks, you should close this issue. |
thanks @Xuanwo . i checked these issues. |
Hi, @WenyXu, I'm closing this issue now. Welcome to leave comment if you have other ideas. |
I found the code bases have mixed two styles of comment. (But maybe it's not a big deal; some other projects I know also have this problem(e.g., arrow-rs)
https://github.com/apache/incubator-opendal/blob/0fe342a18cc1426523d2ded0e51ed99b9c629345/core/src/raw/ops.rs#L369-L395
Based on my experience, I personally prefer to use
descriptive
sentences, which follow the pingcap's style guide.https://pingcap.github.io/style-guide/rust/comments.html
The text was updated successfully, but these errors were encountered: