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

Fixing some doc comments #9646

Merged
merged 11 commits into from
Aug 31, 2023
Merged

Fixing some doc comments #9646

merged 11 commits into from
Aug 31, 2023

Conversation

EmiOnGit
Copy link
Contributor

Objective

I've been collecting some mistakes in the documentation and fixed them

crates/bevy_audio/src/audio.rs Outdated Show resolved Hide resolved
Comment on lines -7 to -9
#[cfg(doc)]
use bevy_hierarchy::BuildChildren;

Copy link
Contributor

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.

Copy link
Contributor Author

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

Copy link
Contributor

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
Copy link
Contributor

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.

Copy link
Contributor Author

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?

Copy link
Contributor

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>
@alice-i-cecile alice-i-cecile added the C-Docs An addition or correction to our documentation label Aug 31, 2023
@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Aug 31, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Aug 31, 2023
Merged via the queue into bevyengine:main with commit 3527288 Aug 31, 2023
23 checks passed
@EmiOnGit EmiOnGit deleted the docs branch August 31, 2023 22:57
rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this pull request Jan 9, 2024
# 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants