Mention in .add_observer() docs that first parameter must be a Trigger #19315
Conversation
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
theotherphil
added
C-Docs
hukasu
approved these changes
May 20, 2025
JMS55
reviewed
May 21, 2025
| @@ -536,6 +536,8 @@ impl World { | |||
| /// Spawns a "global" [`Observer`] which will watch for the given event. | |||
| /// Returns its [`Entity`] as a [`EntityWorldMut`]. | |||
| /// | |||
| /// `system` can be any system whose first parameter is a [`Trigger`]. | |||
There was a problem hiding this comment.
Nit: Maybe we want to rename the parameter here to observer to match the rest of the codebase?
There was a problem hiding this comment.
This context maybe feels slightly different from the other two? I have no particular preference though - happy to change if you'd prefer.
JMS55
approved these changes
May 21, 2025
theotherphil
added
S-Ready-For-Final-Review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Objective
Fix #13860
Solution
Add note in docs that Trigger must be the first parameter of observer systems