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.

Sign up for GitHub

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

Jump to bottom

Docs for NextState are outdated #13577

Closed
rparrett opened this issue May 30, 2024 · 1 comment · Fixed by #13578
Closed

Docs for NextState are outdated #13577

rparrett opened this issue May 30, 2024 · 1 comment · Fixed by #13578
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation
Milestone
0.14

Comments

@rparrett
Copy link
Contributor

How can Bevy's documentation be improved?

https://dev-docs.bevyengine.org/bevy/prelude/enum.NextState.html

The docs say

To queue a transition, just set the contained value to Some(next_state).

But NextState is no longer a struct containing an enum.

Relevant PR: #11426

I am not sure if the text about transitions below is correct -- I didn't follow these changes.
@rparrett rparrett added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels May 30, 2024
@alice-i-cecile alice-i-cecile added A-ECS Entities, components, systems, and events and removed S-Needs-Triage This issue needs to be labelled labels May 30, 2024
@alice-i-cecile alice-i-cecile added this to the 0.14 milestone May 30, 2024
@alice-i-cecile
Copy link
Member

I'll take this.

@alice-i-cecile alice-i-cecile mentioned this issue May 30, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 30, 2024
@alice-i-cecile
Update docs for NextState (#13578)
61af3d2 
# Objective

Fixes #13577.

## Solution

Explain how the resource works now.

Co-authored-by: Alice Cecile <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation
Projects
None yet
Milestone
0.14
Development

Successfully merging a pull request may close this issue.

Update docs for NextState alice-i-cecile/bevy
2 participants
@rparrett @alice-i-cecile