Skip to content
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

Add example using State in docs #11319

Merged
merged 3 commits into from
Jan 13, 2024
Merged

Conversation

BD103
Copy link
Member

@BD103 BD103 commented Jan 13, 2024

Objective

Solution

  • Add an example using State in a system in the docs, to clarify that it is a Resource.

I basically copied the example from States and added a system beside it. I don't have a strong opinion on what the example should look like, so please comment if you have a better idea. :)

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events labels Jan 13, 2024
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Can you add a matching one to NextState that changes the state?

@BD103 BD103 requested a review from alice-i-cecile January 13, 2024 02:39
@matiqo15 matiqo15 added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jan 13, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 13, 2024
Merged via the queue into bevyengine:main with commit 9926123 Jan 13, 2024
23 checks passed
@BD103 BD103 deleted the doc-state-example branch January 13, 2024 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing docs in prelude::State
4 participants