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

Unify the comment style. #3807

Closed
WenyXu opened this issue Dec 23, 2023 · 6 comments
Closed

Unify the comment style. #3807

WenyXu opened this issue Dec 23, 2023 · 6 comments

Comments

@WenyXu
Copy link
Member

WenyXu commented Dec 23, 2023

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.

When used for description, comments should be descriptive rather than imperative.

Opens the file (Good)
Open the file (Bad)

https://pingcap.github.io/style-guide/rust/comments.html

@ankit-pn
Copy link
Contributor

Hey I want to work on this issue, it would be great if anyone assign this to me!
Thanks

@Xuanwo
Copy link
Member

Xuanwo commented Dec 23, 2023

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.

@ankit-pn
Copy link
Contributor

Ok thanks, you should close this issue.

@Xuanwo
Copy link
Member

Xuanwo commented Dec 23, 2023

Ok thanks, you should close this issue.

Thank you for your interest in this project! You might want to check out these beginner-friendly issues: #3240 and #3803.

@ankit-pn
Copy link
Contributor

thanks @Xuanwo . i checked these issues.

@Xuanwo
Copy link
Member

Xuanwo commented Dec 23, 2023

Hi, @WenyXu, I'm closing this issue now. Welcome to leave comment if you have other ideas.

@Xuanwo Xuanwo closed this as not planned Won't fix, can't repro, duplicate, stale Dec 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants