Add link to documentation #146
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
veelenga
reviewed
Nov 17, 2024
src/ameba.ts
Outdated
| @@ -91,6 +91,11 @@ export class Ameba { | |||
| `[${issue.rule_name}] ${issue.message}`, | |||
| this.parseSeverity(issue.severity) | |||
| ); | |||
| diag.code = { | |||
| value: "Docs", | |||
| target: Uri.parse(`https://crystal-ameba.github.io/ameba/Ameba/Rule/${issue.rule_name}.html#overview`) | |||
There was a problem hiding this comment.
this should probably use the versioning. @Sija wdyt?
There was a problem hiding this comment.
If versioning is important I can point it at crystaldoc.info, https://crystaldoc.info/github/crystal-ameba/ameba/v1.6.3/Ameba/Rule/Lint/AmbiguousAssignment.html
There was a problem hiding this comment.
@nobodywasishere that might be a good option
There was a problem hiding this comment.
It's good for now, although I'd prefer to avoid 3rd party services.
crystaldoc.info has documentation for all versions of ameba, allowing for more accurate docs for the user
veelenga
approved these changes
Nov 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which points to https://crystal-ameba.github.io/ameba/Ameba/Rule/Lint/UselessAssign.html#overview