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.

Sign up for GitHub

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

Jump to bottom

Allow every diagnostic to define a documentation url #4142

Closed
timotheeguerin opened this issue Aug 12, 2024 · 1 comment · Fixed by #4442
Closed

Allow every diagnostic to define a documentation url #4142

timotheeguerin opened this issue Aug 12, 2024 · 1 comment · Fixed by #4442
Assignees
@timotheeguerin
Labels
compiler:core Issues for @typespec/compiler feature New feature or request triaged:core
Milestone
[2024] October

Comments

@timotheeguerin
Copy link
Member

timotheeguerin commented Aug 12, 2024 •
edited
Loading

Similar to how we have that for linter rules each diagnositc should be able to define their documentation url.

With this PR #4141 this would allow user to dig into more info very easily

 "digit-expected": {
    severity: "error",
+   url: "https://typespec.io/compiler/diagnostics/digit-expected"
    messages: {
      default: "Digit expected.",
    },
  },
@markcowl
Copy link
Contributor

est: 3

@markcowl markcowl added triaged:core compiler:core Issues for @typespec/compiler feature New feature or request labels Aug 12, 2024
@markcowl markcowl added this to the [2024] October milestone Aug 12, 2024
@timotheeguerin timotheeguerin self-assigned this Sep 13, 2024
@timotheeguerin timotheeguerin mentioned this issue Sep 13, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Oct 4, 2024
@timotheeguerin
Add url property to diagnostic (#4442)
68c94a7 
fix [#4142](#4142)
Every diagnostic can now define a url pointing to a documentation with
more information on how you might have this diagnostic and how to
resolve it
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@timotheeguerin timotheeguerin

Labels
compiler:core Issues for @typespec/compiler feature New feature or request triaged:core
Projects
None yet
Milestone
[2024] October
Development

Successfully merging a pull request may close this issue.

Add url property to diagnostic timotheeguerin/typespec
2 participants
@timotheeguerin @markcowl