Skip to content

Improve AssetEvent docs #21796

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

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Improve AssetEvent docs #21796

wants to merge 5 commits into from
+42 −1

Conversation

@menochs1
Copy link

@menochs1 menochs1 commented Nov 10, 2025

Objective

Solution

  • I wrote some extra doccumentation above AssetEvent that more clearly describes it.

Testing

  • There was no testing since it only involved doccumentation

alice-i-cecile
alice-i-cecile reviewed Nov 10, 2025
View reviewed changes
crates/bevy_asset/src/event.rs
/// messages are emitted by the asset system to notify other systems about
/// lifecycle changes for individual assets:
///
/// - `Added`: a new asset value was inserted into the asset storage.
Copy link
Member

@alice-i-cecile alice-i-cecile Nov 10, 2025

Choose a reason for hiding this comment

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

IMO these are best left to the individual variants. We should improve the docs there as needed, and avoid duplicating this information.

alice-i-cecile
alice-i-cecile reviewed Nov 10, 2025
View reviewed changes
crates/bevy_ecs/src/system/system_registry.rs

/// Runs a cached system, registering it if necessary.
///
/// # Type Inference Note
Copy link
Member

@alice-i-cecile alice-i-cecile Nov 10, 2025

Choose a reason for hiding this comment

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

This file should not be changed here: this looks like a git mishap :)

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Assets Load files from disk to use for things like images, models, and sounds X-Uncontroversial This work is generally agreed upon D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Nov 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alice-i-cecile alice-i-cecile alice-i-cecile left review comments

Assignees

No one assigned

Labels

A-Assets Load files from disk to use for things like images, models, and sounds C-Docs An addition or correction to our documentation D-Straightforward Simple bug fixes and API improvements, docs, test and examples S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged X-Uncontroversial This work is generally agreed upon

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve AssetEvent docs

3 participants

@menochs1 @alice-i-cecile @DylanD42