-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Fixing some doc comments #9646
Fixing some doc comments #9646
Changes from all commits
b34495a
5c5c4ef
4b59717
5465754
738b552
3cc8c90
cc8a55d
c9e1c0f
d832745
81b784a
96959fa
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -63,10 +63,10 @@ use crate::web_resize::{CanvasParentResizeEventChannel, CanvasParentResizePlugin | |
#[cfg(target_os = "android")] | ||
pub static ANDROID_APP: std::sync::OnceLock<AndroidApp> = std::sync::OnceLock::new(); | ||
|
||
/// A [`Plugin`] that uses [`winit`] to create and manage windows, and receive window and input | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why remove the crate-level links? I find them useful. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. in the docs the links are not displayed and look a bit weird in return. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. They work on locally generated versions of the doc (by running But I'm OK with removing them if they don't works on docs.rs |
||
/// A [`Plugin`] that uses `winit` to create and manage windows, and receive window and input | ||
/// events. | ||
/// | ||
/// This plugin will add systems and resources that sync with the [`winit`] backend and also | ||
/// This plugin will add systems and resources that sync with the `winit` backend and also | ||
/// replace the exising [`App`] runner with one that constructs an [event loop](EventLoop) to | ||
/// receive window and input events from the OS. | ||
#[derive(Default)] | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why remove the doc import? I find it better than repeating multiple times the full path in-line.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The links were not working on my end.
See latest doc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oooh I see. For this one, this is a correct change.