Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Missing docs for comment-spacings rule #1062

Closed
BryceBeagle opened this issue Oct 17, 2024 · 3 comments · Fixed by #1129
Closed

Missing docs for comment-spacings rule #1062

BryceBeagle opened this issue Oct 17, 2024 · 3 comments · Fixed by #1129

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.

@chavacava
Copy link
Collaborator

Hi @BryceBeagle thanks for reporting the issue

@alexandear
Copy link
Contributor

@chavacava, the problem extends beyond just missing the comment-spacings rule. The website https://revive.run/ is outdated and lacks descriptions for all the rules added in the last three years. See the issue mgechev/revive.run#60. There are two possible solutions I see:

  1. Shut down the website https://revive.run/ and direct everyone to this GitHub repository for documentation.
  2. Update the website https://revive.run/. However, we would need permission from @mgechev to do so in the repo https://github.com/mgechev/revive.run.

@chavacava
Copy link
Collaborator

Hi @mgechev, do you think it is possible to update the revive.run site ?

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants