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.

Sign up for GitHub

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

Jump to bottom

Warn methods in doc comments written as fun() instead of fun #1750

Open
clarfonthey opened this issue May 11, 2017 · 1 comment
Open

Warn methods in doc comments written as fun() instead of fun #1750

clarfonthey opened this issue May 11, 2017 · 1 comment
Labels
A-documentation Area: Adding or improving documentation L-style Lint: Belongs in the style lint group S-needs-discussion Status: Needs further discussion before merging or work can be started T-AST Type: Requires working with the AST

Comments

@clarfonthey
Copy link
Contributor

clarfonthey commented May 11, 2017 •
edited
Loading

According to #41771 (comment), the current convention for rustdoc is to write methods without any trailing parentheses. For example, the comment "Resizes the Vec in-place so that len() is equal to new_len" should really be "Resizes the Vec in-place so that len is equal to new_len".

Would be nice if we had some way for clippy to warn about this convention.
@clarfonthey clarfonthey mentioned this issue May 11, 2017
Merged
@oli-obk oli-obk added L-style Lint: Belongs in the style lint group good-first-issue These issues are a good way to get started with Clippy A-documentation Area: Adding or improving documentation T-AST Type: Requires working with the AST labels May 12, 2017
@clarfonthey
Copy link
Contributor Author

Note: the original comment on this disputed the usefulness of this convention, so, before this is implemented there should be a consensus on whether the parentheses are preferred or if we'd rather not have them.

@oli-obk oli-obk added the S-needs-discussion Status: Needs further discussion before merging or work can be started label May 16, 2017
@phansch phansch removed the good-first-issue These issues are a good way to get started with Clippy label May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-documentation Area: Adding or improving documentation L-style Lint: Belongs in the style lint group S-needs-discussion Status: Needs further discussion before merging or work can be started T-AST Type: Requires working with the AST
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@oli-obk @Manishearth @phansch @flip1995 @clarfonthey