-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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.
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
menochs1
wants to merge
5
commits into
bevyengine:main
Choose a base branch
from
DylanD42:AssetEvent-Docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+42
−1
Open
Improve AssetEvent docs #21796
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6254ce5
documented run_system_cached #21617
DylanD42 257f5a7
Merge branch 'main' into main
DylanD42 241977f
fixed run_system_cached_with documentation
DylanD42 3f43a33
Merge branch 'main' of https://github.com/DylanD42/Group5Bevy
DylanD42 97b6e4f
Improved AssetEvent Docs
menochs1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -500,6 +500,16 @@ impl World { | |
|
|
||
| /// Runs a cached system, registering it if necessary. | ||
| /// | ||
| /// # Type Inference Note | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 :) |
||
| /// If the system returns `()`, you may need to explicitly constrain the output | ||
| /// type for error handling: | ||
| /// | ||
| /// ```rust | ||
| /// () = world.run_system_cached(my_system)?; | ||
| /// ``` | ||
| /// | ||
| /// Without this, Rust may fail to infer the system’s output type and produce | ||
| /// a `IntoResult<!>` inference error. | ||
| /// See [`World::register_system_cached`] for more information. | ||
| pub fn run_system_cached<O: 'static, M, S: IntoSystem<(), O, M> + 'static>( | ||
| &mut self, | ||
|
|
@@ -508,8 +518,21 @@ impl World { | |
| self.run_system_cached_with(system, ()) | ||
| } | ||
|
|
||
| /// Runs a cached system with an input, registering it if necessary. | ||
| /// Runs a cached system with the provided input, registering it if necessary. | ||
| /// | ||
| /// This is a more general version of [`World::run_system_cached`], allowing | ||
| /// callers to supply an explicit system input. | ||
| /// | ||
| /// # Type Inference Note | ||
| /// If the system returns `()`, you may need to explicitly constrain the | ||
| /// output type for proper error inference: | ||
| /// | ||
| /// ```rust | ||
| /// () = world.run_system_cached_with(my_system, input)?; | ||
| /// ``` | ||
| /// | ||
| /// Without this, Rust may fail to infer the system’s output type and produce | ||
| /// a `IntoResult<!>` inference error. | ||
| /// See [`World::register_system_cached`] for more information. | ||
| pub fn run_system_cached_with<I, O, M, S>( | ||
| &mut self, | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
IMO these are best left to the individual variants. We should improve the docs there as needed, and avoid duplicating this information.