-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
[Merged by Bors] - Adding transform example links to documentation #5997
Conversation
You can also see in the CI that it's complaining about lack of formatting :) https://github.com/bevyengine/bevy/actions/runs/3070501643/jobs/4960290437 That's an easy fix; just follow the directions there. |
Can you mention that this is for the Transform examples in your PR title? They get turned into commit names so it's useful to see what exactly was done at a glance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got there :D I'm happy with this now; I think that this will help improve discoverability nicely.
@bwhitt7 you can press "Resolve conversation" on the comments you've addressed. It's very useful for reviewers so they can have a better idea of the current state of the PR. |
@alice-i-cecile gotcha! thank you for your help |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks mostly good, thanks for helping the documentation effort!
@@ -26,14 +26,22 @@ use std::ops::Mul; | |||
/// This system runs in stage [`CoreStage::PostUpdate`](crate::CoreStage::PostUpdate). If you | |||
/// update the [`Transform`] of an entity in this stage or after, you will notice a 1 frame lag | |||
/// before the [`GlobalTransform`] is updated. | |||
/// | |||
/// Examples: [`transform`](https://github.com/bevyengine/bevy/blob/latest/examples/transforms/transform.rs), [`global_vs_local_translation.rs`](https://github.com/bevyengine/bevy/blob/latest/examples/transforms/global_vs_local_translation.rs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should settle on either including or excluding the .rs
extension, but avoid mixing styles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job. I suggested to list the example links into a dedicated “Examples” section. Vertical space is not an issue for those items. The only exception was for the fields, where it's nice to have visually compact info. I also paraphrased there to make it a little nicer to read.
I also converted link style to reference, for readability. Finally I removed the .rs
extension in the link text.
@Nilirad thank you for your suggestions, i think these are really nice changes. i've never used github much before, so I'm unsure where to go from here. would i commit your suggestions? |
You can go the Files Changed tab, add the suggestions to a batch and then commit the suggestions :) |
You can also check this page to see how to apply suggestions: |
Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked the output. Looks OK overall.
Congrats on your first merged PR :) bors r+ |
# Objective Working on issue #1934 , with linking examples to the documentation. PR for transform examples. ## Solution Added to the documentation in bevy_transform transform.rs and global_transform.rs utilizing links from examples. [X] 3d_rotations.rs linked to rotate in Transform [X] global_vs_local_translation.rs linked to top of Transform and GlobalTransform documentation [X] scale.rs linked to scale Struct in Transform [X] transform.rs linked to top of Transform documentation [X] translation.rs linked to from_translation in Transform Co-authored-by: bwhitt7 <103079612+bwhitt7@users.noreply.github.com>
Pull request successfully merged into main. Build succeeded: |
# Objective Working on issue bevyengine#1934 , with linking examples to the documentation. PR for transform examples. ## Solution Added to the documentation in bevy_transform transform.rs and global_transform.rs utilizing links from examples. [X] 3d_rotations.rs linked to rotate in Transform [X] global_vs_local_translation.rs linked to top of Transform and GlobalTransform documentation [X] scale.rs linked to scale Struct in Transform [X] transform.rs linked to top of Transform documentation [X] translation.rs linked to from_translation in Transform Co-authored-by: bwhitt7 <103079612+bwhitt7@users.noreply.github.com>
# Objective Working on issue bevyengine#1934 , with linking examples to the documentation. PR for transform examples. ## Solution Added to the documentation in bevy_transform transform.rs and global_transform.rs utilizing links from examples. [X] 3d_rotations.rs linked to rotate in Transform [X] global_vs_local_translation.rs linked to top of Transform and GlobalTransform documentation [X] scale.rs linked to scale Struct in Transform [X] transform.rs linked to top of Transform documentation [X] translation.rs linked to from_translation in Transform Co-authored-by: bwhitt7 <103079612+bwhitt7@users.noreply.github.com>
# Objective Working on issue bevyengine#1934 , with linking examples to the documentation. PR for transform examples. ## Solution Added to the documentation in bevy_transform transform.rs and global_transform.rs utilizing links from examples. [X] 3d_rotations.rs linked to rotate in Transform [X] global_vs_local_translation.rs linked to top of Transform and GlobalTransform documentation [X] scale.rs linked to scale Struct in Transform [X] transform.rs linked to top of Transform documentation [X] translation.rs linked to from_translation in Transform Co-authored-by: bwhitt7 <103079612+bwhitt7@users.noreply.github.com>
Objective
Working on issue #1934 , with linking examples to the documentation. PR for transform examples.
Solution
Added to the documentation in bevy_transform transform.rs and global_transform.rs utilizing links from examples.
[X] 3d_rotations.rs linked to rotate in Transform
[X] global_vs_local_translation.rs linked to top of Transform and GlobalTransform documentation
[X] scale.rs linked to scale Struct in Transform
[X] transform.rs linked to top of Transform documentation
[X] translation.rs linked to from_translation in Transform