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

Lint for 4 / (////) to help detect broken doc comments #9212

Closed
alice-i-cecile opened this issue Jul 20, 2022 · 0 comments · Fixed by #11140
Closed

Lint for 4 / (////) to help detect broken doc comments #9212

alice-i-cecile opened this issue Jul 20, 2022 · 0 comments · Fixed by #11140
Labels
A-lint Area: New lints

Comments

@alice-i-cecile
Copy link

What it does

Detects four consecutive forward slash characters.

This is almost always indicative of a broken doc comment.

Lint Name

four-forward-slashes

Category

suspicious

Advantage

  • The doc comment appears as expected.

Drawbacks

Users may have a non-standard style that uses 4 forward slashes semantically.

Example

//// The life total of a unit
struct Life(u8);

Was likely intended to be:

/// The life total of a unit
struct Life(u8);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-lint Area: New lints
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant