bevyengine / bevyengine/bevy

Improve `AssetEvent` docs

Open
#11,943 2 comments 2 reactions 0 assignees View on GitHub
A-Assets C-Docs D-Trivial
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 16h
Merged PRs (30d)
171

Description

The docs for [`AssetEvent`](https://docs.rs/bevy/latest/bevy/asset/prelude/enum.AssetEvent.html) are a bit vague on what exactly it means for an asset to be "added", or "modified" or "loaded with dependencies".

For instance, when hot-reloading an asset, we expect `Modified` to fire, but what about `LoadedWithDependencies`? Will that fire? What if the newly modified asset has additional dependencies?

It should be easy to deduce exactly when an asset event will fire for a particular sequence of asset operations.

Contributor guide

Open the contributing guide

Research direction

Start with the AssetEvent API documentation linked in the issue and trace the documented asset operations, including hot-reloading and dependency changes. Clarify exactly when Added, Modified, and LoadedWithDependencies fire for each sequence, including modified dependencies, and update the docs so those outcomes are unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.