Skip to content

Fix link in documentation of widget::Image #1730

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

Merged
cmyr merged 3 commits into from
Apr 28, 2021
Merged

Fix link in documentation of widget::Image #1730

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2455ba5
Fix link in documentation of widget::Image
RichardPoole42 Apr 20, 2021
f038b2a
Let rustdoc resolve links
RichardPoole42 Apr 27, 2021
d908236
Add link to PR
RichardPoole42 Apr 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ You can find its changes [documented below](#070---2021-01-01).
- Fixed docs describing `ViewSwitcher` widget functionality ([#1693] by [@arthmis])
- Added missing documentation on derived lens items ([#1696] by [@lidin])
- Fix example code in `Get started with Druid` chapter of book ([#1698] by [@ccqpein])
- Fix link in documentation of widget::Image ([#1730] by [@RichardPoole42])

### Examples

Expand Down Expand Up @@ -457,6 +458,7 @@ Last release without a changelog :(
[@xarvic]: https://github.com/xarvic
[@arthmis]: https://github.com/arthmis
[@ccqpein]: https://github.com/ccqpein
[@RichardPoole42]: https://github.com/RichardPoole42

[#599]: https://github.com/linebender/druid/pull/599
[#611]: https://github.com/linebender/druid/pull/611
Expand Down
2 changes: 1 addition & 1 deletion druid/src/widget/image.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ use tracing::{instrument, trace};
///
/// [scaling a bitmap image]: ../struct.Scale.html#pixels-and-display-points
/// [SVG files]: https://en.wikipedia.org/wiki/Scalable_Vector_Graphics
/// [`ImageBuf`]: ../druid_shell/struct.ImageBuf.html
/// [`ImageBuf`]: ../piet/struct.ImageBuf.html
/// [`FillStrat`]: ../widget/enum.FillStrat.html
/// [`InterpolationMode`]: ../piet/enum.InterpolationMode.html
Copy link
Member

@jneem jneem Apr 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

@cmyr cmyr Apr 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@RichardPoole42 RichardPoole42 Apr 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated with those three lines completely removed. All three links do work in the built documentation.

pub struct Image {
Expand Down