Add links for types from dependencies #358
Open
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.
The main thing this PR does is add links for types that are defined in dependencies.
The motivation is to be able to quickly navigate to related documentation that is directly relevant to a package's docs. It also helps to disambiguate what types a package uses, which is particularly useful for heavily overloaded type names such as
Color
(I can never figure out which one is intended 😅).In order to do this we have to find out which version of a dependency to link to. While it might be tempting to link to the latest version, it could lead to broken links if the type is removed/changed in the latest version of the dependency. As such we instead link to the most recent version that matches the constraint associated with the dependency. In this PR I am calling this a
ResolvedDep
.This PR does 2 extra things:
ResolvedDep
instead oflatest
if the dependency could be resolved.