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

Add hyperlinks to diagnostic documentation url #4148

Merged
merged 7 commits into from
Aug 12, 2024
Merged

Add hyperlinks to diagnostic documentation url #4148

merged 7 commits into from
Aug 12, 2024

Conversation

timotheeguerin
Copy link
Member

@timotheeguerin timotheeguerin commented Aug 12, 2024 •
edited
Loading

Make the diagnostic code an hyperlink that point to the documentation url

image

@microsoft-github-policy-service microsoft-github-policy-service bot added the compiler:core Issues for @typespec/compiler label Aug 12, 2024
@azure-sdk
Copy link
Collaborator

azure-sdk commented Aug 12, 2024 •
edited
Loading

All changed packages have been documented.

  • ✅ @typespec/compiler
Show changes

@typespec/compiler - feature ✏️

Diagnostics logged to the terminal now have a clickable hyperlink to the diagnostic documentation url if applicable.

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@timotheeguerin @markcowl
Update .chronus/changes/feature-cli-hyperlinks-2024-7-12-20-48-20.md
1534128 
Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
@timotheeguerin timotheeguerin added this pull request to the merge queue Aug 12, 2024
Merged via the queue into microsoft:main with commit 4cced29 Aug 12, 2024
22 checks passed
@timotheeguerin timotheeguerin deleted the feature/cli-hyperlinks branch August 12, 2024 22:45
sarangan12 pushed a commit to sarangan12/typespec that referenced this pull request Sep 16, 2024
@timotheeguerin @markcowl @sarangan12
Add hyperlinks to diagnostic documentation url (microsoft#4148)
958c183 
Make the diagnostic code an hyperlink that point to the documentation
url

<img width="488" alt="image"
src="https://github.com/user-attachments/assets/dd6518be-b49f-4bf1-b4ca-ceed525922ff">

---------

Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markcowl markcowl markcowl approved these changes

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@allenjzhang allenjzhang Awaiting requested review from allenjzhang allenjzhang is a code owner

Assignees
No one assigned
Labels
compiler:core Issues for @typespec/compiler
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@timotheeguerin @azure-sdk @markcowl