Skip to content

Time<Real> documentation improvement#15874

Merged
alice-i-cecile merged 5 commits intobevyengine:mainfrom
BenjaminBrienen:time-doc
Oct 13, 2024
Merged

Time<Real> documentation improvement#15874
alice-i-cecile merged 5 commits intobevyengine:mainfrom
BenjaminBrienen:time-doc

Conversation

@BenjaminBrienen
Copy link
Copy Markdown
Contributor

@BenjaminBrienen BenjaminBrienen commented Oct 12, 2024

Objective

Fixes #15445

Solution

Add a note to the doc comment for Real.

Testing

Viewed the built documentation.

Showcase

image
*possible bug in rustdoc rendering the footnote

@BenjaminBrienen BenjaminBrienen added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Time Involves time keeping and reporting S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 12, 2024
@BenjaminBrienen
Copy link
Copy Markdown
Contributor Author

@Neutron3529 your opinion would be appreciated on this

@BenjaminBrienen BenjaminBrienen self-assigned this Oct 12, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 13, 2024
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 13, 2024
Merged via the queue into bevyengine:main with commit 0720e62 Oct 13, 2024
@BenjaminBrienen BenjaminBrienen deleted the time-doc branch October 29, 2024 21:56
@BenjaminBrienen BenjaminBrienen removed 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 Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Time Involves time keeping and reporting C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make the use case for configuring TimeUpdateStrategy and Time<Real> more clear

3 participants