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

Links to schedules and conditions are broken in various state docs #13845

Closed
rparrett opened this issue Jun 14, 2024 · 2 comments · Fixed by #13929
Closed

Links to schedules and conditions are broken in various state docs #13845

rparrett opened this issue Jun 14, 2024 · 2 comments · Fixed by #13929
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy X-Uncontroversial This work is generally agreed upon

Comments

@rparrett
Copy link
Contributor

rparrett commented Jun 14, 2024 •
edited
Loading

How can Bevy's documentation be improved?

https://dev-docs.bevyengine.org/bevy/prelude/trait.AppExtStates.html#tymethod.init_state

Links to OnEnter, in_state, etc are broken.
@rparrett rparrett added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Jun 14, 2024
@rparrett rparrett changed the title Links to schedules are broken in various state docs Links to schedules and conditions are broken in various state docs Jun 14, 2024
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events X-Uncontroversial This work is generally agreed upon and removed S-Needs-Triage This issue needs to be labelled labels Jun 14, 2024
@kettei-sproutty
Copy link
Contributor

Hi, I would like to take this issue, should i include insertState that have the same broken links too?

@rparrett
Copy link
Contributor Author

Yes, please!

@kettei-sproutty kettei-sproutty mentioned this issue Jun 19, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Jun 19, 2024
@kettei-sproutty
docs(bevy_state): fix broken links in init_state and insert_state (#1…
5bab161 
…3929)

# Objective

Fixes #13845 

## Solution

Fix inline docs links inside `init_state` and `insert_state`. 

## Testing

- Did you test these changes? If so, how?
Manually checked on `cargo doc` and  `rust-analyzer lsp`.
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 D-Trivial Nice and easy! A great choice to get started with Bevy X-Uncontroversial This work is generally agreed upon
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(bevy_state): fix broken links in init_state and insert_state kettei-sproutty/bevy
3 participants
@rparrett @alice-i-cecile @kettei-sproutty