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.

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

In the docs for iced add links to the widgets in iced_native #340

Closed
SpyrosRoum opened this issue May 11, 2020 · 4 comments
Closed

In the docs for iced add links to the widgets in iced_native #340

SpyrosRoum opened this issue May 11, 2020 · 4 comments
Labels
documentation improvement An internal improvement
Milestone

Comments

@SpyrosRoum
Copy link

For example, the doc for the button widget has this text only:

A widget that produces a message when clicked.

This is an alias of an iced_native button with an iced_wgpu::Renderer.

That means that I have to search and find the docs for iced_native and find the widgets there but I think it would make sense to at least have a link that can take you to the iced_native version of the widget

@SpyrosRoum SpyrosRoum changed the title In the docs for ice add links to the widgets in iced_native In the docs for iced add links to the widgets in iced_native May 11, 2020
@hecrj
Copy link
Member

hecrj commented May 13, 2020

We should figure out why docs.rs isn't linking the type alias automatically.

If I run cargo doc --no-deps --all locally, I do get a proper link.

@hecrj hecrj added the improvement An internal improvement label May 13, 2020
@hecrj hecrj added this to the 0.2.0 milestone May 13, 2020
@Imberflur
Copy link
Contributor

strangely in the iced_wgpu docs where I assume it gets these docs from there is a link https://docs.rs/iced_wgpu/0.2.2/iced_wgpu/widget/button/type.Button.html

@hecrj
Copy link
Member

hecrj commented May 29, 2020

We may need to add iced_native as an explicit dependency of iced.

@hecrj
Copy link
Member

hecrj commented May 3, 2022

This has been fixed since #1328.

@hecrj hecrj closed this as completed May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation improvement An internal improvement
Projects
None yet
Development

No branches or pull requests

3 participants