Update example system in documentation #1403
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
The existing snippet fails to compile with
```
no method named `system` found for fn item `fn(bevy::prelude::Commands) {example_system}` in the current scope
```
|
Why isn't the example tested on CI? |
|
That ... is a very good question. |
|
I believe CI didn't catch this because this fails when you call |
|
iirc theres a way to add "wrapper" code that doesn't show up in the example, but is executed. If so, thats probably the way to approach this. |
|
The Way to hide Code in doctests is documented here: https://doc.rust-lang.org/rustdoc/documentation-tests.html#hiding-portions-of-the-example |
Merged
szunami
added a commit
to szunami/bevy
that referenced
this pull request
Feb 5, 2021
This is intended to act as a CI time assertion that `example_system` is a real system. See conversation here: bevyengine#1403
szunami
added a commit
to szunami/bevy
that referenced
this pull request
Feb 5, 2021
This is intended to act as a CI time assertion that `example_system` is a real system. See conversation here: bevyengine#1403
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.
The existing snippet fails to compile with