-
-
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
Conversation
#[cfg(doc)] | ||
use bevy_hierarchy::BuildChildren; | ||
|
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.
@@ -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 comment
The 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 comment
The 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.
Is this still wanted behavior?
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.
They work on locally generated versions of the doc (by running cargo doc --open
) which is generally more useful, since the search bar can search for docs on more than a single dependency.
But I'm OK with removing them if they don't works on docs.rs
Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>
# Objective I've been collecting some mistakes in the documentation and fixed them --------- Co-authored-by: Emi <emanuel.boehm@gmail.com> Co-authored-by: Nicola Papale <nicopap@users.noreply.github.com>
Objective
I've been collecting some mistakes in the documentation and fixed them