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

Missing docs for comment-spacings rule #1062

Open
BryceBeagle opened this issue Oct 17, 2024 · 0 comments
Open

Missing docs for comment-spacings rule #1062

BryceBeagle opened this issue Oct 17, 2024 · 0 comments

Comments

@BryceBeagle
Copy link

Describe the bug
A clear and concise description of what the bug is.

revive outputs links to docs for each rule. There are missing docs for the comment-spacings rule

The link in

│    (121, 3)  https://revive.run/r#comment-spacings  no space between comment delimiter and comment text     │

takes the user to a non-existent section on the docs page.

To Reproduce

  • Introduce comment-spacings lint violation
  • Use an output format that includes links to the docs for the violated rule
  • Click embedded link to docs

Expected behavior
Docs should be present for this rule

Additional context

This rule is pretty self-explanatory, but it would be nice to have docs for it for the sake of completion.

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

1 participant