You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
clarfonthey opened this issue
Jan 20, 2017
· 1 comment
Labels
A-lintArea: New lintsE-hardCall for participation: This a hard problem and requires more experience or effort to work onT-middleType: Probably requires verifiying types
Sort of long explanation for a simple thing: it's very common in Rust to provide code examples in doc comments to explain how a method is used. However, sometimes methods are the same, and we accidentally copy-paste a doc comment which does not actually call the method it's documenting. This should warn by default, because it's probably a mistake.
I don't think that this warning should warn for doc comments which don't contain code examples, just specifically ones that don't call the thing they're documenting. The former would be better for rustfmt, whereas the latter is something that would be good for a linter like clippy.
The text was updated successfully, but these errors were encountered:
mcarton
added
E-hard
Call for participation: This a hard problem and requires more experience or effort to work on
A-lint
Area: New lints
T-middle
Type: Probably requires verifiying types
labels
Jun 10, 2017
A-lintArea: New lintsE-hardCall for participation: This a hard problem and requires more experience or effort to work onT-middleType: Probably requires verifiying types
Sort of long explanation for a simple thing: it's very common in Rust to provide code examples in doc comments to explain how a method is used. However, sometimes methods are the same, and we accidentally copy-paste a doc comment which does not actually call the method it's documenting. This should warn by default, because it's probably a mistake.
I don't think that this warning should warn for doc comments which don't contain code examples, just specifically ones that don't call the thing they're documenting. The former would be better for rustfmt, whereas the latter is something that would be good for a linter like clippy.
The text was updated successfully, but these errors were encountered: