Fix link in documentation of widget::Image#1730
Merged
cmyr merged 3 commits intolinebender:masterfrom Apr 28, 2021
Merged
Conversation
struct ImageBuf now lives in piet not in druid-shell
jneem
reviewed
Apr 23, 2021
Member
jneem
left a comment
jneem
left a comment
There was a problem hiding this comment.
Good catch! I think we can do even better, though, now that intra-doc links are stable. This way, the compiler will catch it next time it breaks.
druid/src/widget/image.rs
Outdated
Comment on lines
72
to
74
| /// [`ImageBuf`]: ../piet/struct.ImageBuf.html | ||
| /// [`FillStrat`]: ../widget/enum.FillStrat.html | ||
| /// [`InterpolationMode`]: ../piet/enum.InterpolationMode.html |
Member
There was a problem hiding this comment.
Suggested change
| /// [`ImageBuf`]: ../piet/struct.ImageBuf.html | |
| /// [`FillStrat`]: ../widget/enum.FillStrat.html | |
| /// [`InterpolationMode`]: ../piet/enum.InterpolationMode.html | |
| /// [`ImageBuf`]: piet::ImageBuf | |
| /// [`FillStrat`]: crate::widget::FillStrat | |
| /// [`InterpolationMode`]: piet::InterpolationMode |
Member
There was a problem hiding this comment.
we can do even better: if these types are in scope, we don't need to include explicit links to them at all, rustdoc will automatically resolve links with the format [`Type`] if Type is in scope.
Contributor
Author
There was a problem hiding this comment.
I've updated with those three lines completely removed. All three links do work in the built documentation.
josh-audio
previously requested changes
Apr 27, 2021
josh-audio
added
S-needs-review
josh-audio
dismissed
their stale review
Don't know enough about this to approve, but my review comment is resolved
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
struct ImageBuf now lives in piet not in druid-shell