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

Structure suggestions for link resolution warnings as fixits #438

Closed
d-ronnqvist opened this issue Dec 13, 2022 · 0 comments
Closed

Structure suggestions for link resolution warnings as fixits #438

d-ronnqvist opened this issue Dec 13, 2022 · 0 comments
Labels
enhancement Improvements or enhancements to existing functionality

Comments

@d-ronnqvist
Copy link
Contributor

d-ronnqvist commented Dec 13, 2022 •
edited
Loading

When a documentation link fails to resolve, the diagnostic doesn't have any structured suggestions (fixits).

With the hierarchy-based link resolver implementation there's information about how to change the link so that it would resolve but this information is included in the error message text.

If we moved this information into Solution elements with a Replacement then IDEs could display them as fixits so that the developer could easily apply one of them.

Note that the link resolver doesn't have all the information it needs to create the Solution/Replacement elements (e.g. the source range or URL).
@d-ronnqvist d-ronnqvist added the enhancement Improvements or enhancements to existing functionality label Dec 13, 2022
@d-ronnqvist d-ronnqvist mentioned this issue Dec 13, 2022
Merged
3 tasks
theMomax added a commit to theMomax/swift-docc that referenced this issue Jan 6, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
65401a6 
… as fixits)
theMomax added a commit to theMomax/swift-docc that referenced this issue Jan 6, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
b7208fc 
… as fixits)
theMomax added a commit to theMomax/swift-docc that referenced this issue Jan 6, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
ca3e518 
… as fixits)
theMomax added a commit to theMomax/swift-docc that referenced this issue Jan 6, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
c1f1ec4 
… as fixits)
@theMomax theMomax mentioned this issue Jan 6, 2023
Merged
3 tasks
theMomax added a commit to theMomax/swift-docc that referenced this issue Jan 6, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
63d26cc 
… as fixits)
theMomax added a commit to theMomax/swift-docc that referenced this issue Jan 18, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
b6e1fff 
… as fixits)
@theMomax theMomax mentioned this issue Jan 27, 2023
Open
2 tasks
theMomax added a commit to theMomax/swift-docc that referenced this issue Jan 29, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
1d01b10 
… as fixits)
theMomax added a commit to theMomax/swift-docc that referenced this issue Feb 8, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
ca9d689 
… as fixits)
theMomax added a commit to theMomax/swift-docc that referenced this issue Feb 9, 2023
@theMomax
fix swiftlang#438 (Structure suggestions for link resolution warnings…
bb28aa6 
… as fixits)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improvements or enhancements to existing functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@d-ronnqvist