Copy over docs for Condition trait from PR #10718
#10748
Merged
Conversation
This file contains 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
stepancheg
reviewed
Nov 26, 2023
Comment on lines
21
to
22
| /// Type parameter in return type can be omitted by calling [`IntoSystem::into_system`], | ||
| /// but usually have to be specified when passing a condition to a function. |
There was a problem hiding this comment.
I don't see a button to suggest code edits.
Better replace "can be omitted" with something like "can be set to <()>".
stepancheg
reviewed
Nov 26, 2023
| /// ``` | ||
| /// # use bevy_ecs::schedule::Condition; | ||
| /// # use bevy_ecs::system::IntoSystem; | ||
| /// fn not_condition<Marker>(a: impl Condition<Marker>) -> impl Condition { |
There was a problem hiding this comment.
Here we need <()> in Condition<()>.
ItsDoot
added
C-Docs
alice-i-cecile
changed the title
Condition trait from PR #10718
|
Thanks. I noticed that the other examples have hidden code blocks for testing. Should this one have it as well? |
alice-i-cecile
approved these changes
Nov 26, 2023
james7132
approved these changes
Nov 27, 2023
james7132
added
the
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
Resolves #10743.
Solution
Copied over the documentation written by @stepancheng from PR #10718.
I left out the lines from the doctest where
<()>is removed, as that seemed to be the part people couldn't decide on whether to keep or not.