[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:/bevyengine/bevy/actions/runs/3070501643/jobs/4960290437 That's an easy fix; just follow the directions there. |
alice-i-cecile
added
C-Docs
|
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. |
bwhitt7
changed the title
|
@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 |
| @@ -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:/bevyengine/bevy/blob/latest/examples/transforms/transform.rs), [`global_vs_local_translation.rs`](https:/bevyengine/bevy/blob/latest/examples/transforms/global_vs_local_translation.rs) | |||
There was a problem hiding this comment.
We should settle on either including or excluding the .rs extension, but avoid mixing styles.
There was a problem hiding this comment.
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 <[email protected]>
Nilirad
added
the
S-Ready-For-Final-Review
|
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 <[email protected]>
|
Pull request successfully merged into main. Build succeeded: |
bors
bot
changed the title
# 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 <[email protected]>
# 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 <[email protected]>
# 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 <[email protected]>
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