Skip to content

Fix the doc test for WebAssetPlugin #21968

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −5
Open

Fix the doc test for WebAssetPlugin #21968

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions crates/bevy_asset/src/io/web.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,21 @@ use tracing::warn;
/// Example usage:
///
/// ```rust
/// # use bevy_app::{App, Startup};
/// # use bevy_ecs::prelude::{Commands, Res};
/// # use bevy_asset::web::{WebAssetPlugin, AssetServer};
/// # use bevy_app::{App, Startup, TaskPoolPlugin};
/// # use bevy_ecs::prelude::{Commands, Component, Res};
/// # use bevy_asset::{Asset, AssetApp, AssetPlugin, AssetServer, Handle, io::web::WebAssetPlugin};
/// # use bevy_reflect::TypePath;
/// # struct DefaultPlugins;
/// # impl DefaultPlugins { fn set(plugin: WebAssetPlugin) -> WebAssetPlugin { plugin } }
/// # use bevy_asset::web::AssetServer;
/// # impl DefaultPlugins { fn set(&self, plugin: WebAssetPlugin) -> WebAssetPlugin { plugin } }
/// # #[derive(Asset, TypePath, Default)]
/// # struct Image;
/// # #[derive(Component)]
/// # struct Sprite;
/// # impl Sprite { fn from_image(_: Handle<Image>) -> Self { Sprite } }
/// # fn main() {
/// App::new()
/// # .add_plugins((TaskPoolPlugin::default(), AssetPlugin::default()))
Copy link
Contributor

@kfc35 kfc35 Nov 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

There’s a comment on line 14 that says:
"/// NOTE: Make sure to add this plugin *before* AssetPlugin to properly register http asset sources.”
Does this line contradict that statement? The App is now WebAssetPlugin later than AssetPlugin if I’m interpreting this correctly

/// # .init_asset::<Image>()
Copy link
Contributor

@kfc35 kfc35 Nov 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I’d also assume you’d init the asset after adding the WebAssetPlugin… but I may be mistaken!

/// .add_plugins(DefaultPlugins.set(WebAssetPlugin {
/// silence_startup_warning: true,
/// }))
Expand Down