[Merged by Bors] - Add More Description to the Iter Combinations Documentation#6260
[Merged by Bors] - Add More Description to the Iter Combinations Documentation#6260Carter0 wants to merge 11 commits intobevyengine:mainfrom
Conversation
alice-i-cecile
added
C-Docs
bzm3r
left a comment
bzm3r
left a comment
There was a problem hiding this comment.
Thanks for making this example. I did not know about iter_combinations before today, so this is really cool to learn about. I left some questions about things I did not understand from your example. Hopefully it helps in clarifying them?
|
I don't think this is good example, as the usage here is very abstract. I was expecting something like a showcase of a simple solar system. (Turns out, there is an example lol) In the mean time, I would also like to see the usage of |
Yeah, I agree the example code isn't great. Like it's not a practical game development example. But that's also not what I am trying to teach. I think the confusing thing about iter_combinations is how it works. Like what is a combination and what is a permutation. And I think the best way to teach that is with an example like mine, where I can do things like show [1, 2], [1,3], etc... I'm working on some collision code right now which uses iter_combinations, but I don't think it would do a good job at all of explaining how iter_combinations works. I think the other example of iter_combinations, using the solar system, is a good example of that (though it does need comments IMHO). I was thinking perhaps this would be better off as a doc comment somehow? But I really like having the example of [1, 2], etc. I think it's easier for users to see the pattern and understand what a combination is. Ill try to to make it a comment in the docs, I think it might make more sense there. Also TBH, I think if users know how iter_combinations works, then they basically know how iter_combinations_mut works since I don't think thats the complicated concept here. |
Carter0
changed the title
|
You should change update the docs (or link to this) in |
Carter0
force-pushed
the
add-iter-combinations-example
branch
from
cfe8e0e to
f7f33cd
Compare
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
Left some suggestions on how to improve the wording for clarity and readability. Thanks!
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Carter0
force-pushed
the
add-iter-combinations-example
branch
from
63bbd73 to
71b7ae1
Compare
|
Great work on the changes, thanks! |
|
bors r+ |
# Objective I was trying to implement a collision system for my game, and believed that the iter_combinations method might be what I need. But I couldn't find a simple explanation of what a combination was in Bevy and thought it could use some more explanation. ## Solution I added some description to the documentation that can hopefully further elaborate on what a combination is. I also changed up the docs for the method because a combination is a different thing than a permutation but the Bevy docs seemed to use them interchangeably.
alice-i-cecile
added
the
S-Ready-For-Final-Review
bors
bot
changed the title
…ne#6260) # Objective I was trying to implement a collision system for my game, and believed that the iter_combinations method might be what I need. But I couldn't find a simple explanation of what a combination was in Bevy and thought it could use some more explanation. ## Solution I added some description to the documentation that can hopefully further elaborate on what a combination is. I also changed up the docs for the method because a combination is a different thing than a permutation but the Bevy docs seemed to use them interchangeably.
…ne#6260) # Objective I was trying to implement a collision system for my game, and believed that the iter_combinations method might be what I need. But I couldn't find a simple explanation of what a combination was in Bevy and thought it could use some more explanation. ## Solution I added some description to the documentation that can hopefully further elaborate on what a combination is. I also changed up the docs for the method because a combination is a different thing than a permutation but the Bevy docs seemed to use them interchangeably.
…ne#6260) # Objective I was trying to implement a collision system for my game, and believed that the iter_combinations method might be what I need. But I couldn't find a simple explanation of what a combination was in Bevy and thought it could use some more explanation. ## Solution I added some description to the documentation that can hopefully further elaborate on what a combination is. I also changed up the docs for the method because a combination is a different thing than a permutation but the Bevy docs seemed to use them interchangeably.
5 participants
Objective
I was trying to implement a collision system for my game, and believed that the iter_combinations method might be what I need. But I couldn't find a simple explanation of what a combination was in Bevy and thought it could use some more explanation.
Solution
I added some description to the documentation that can hopefully further elaborate on what a combination is.
I also changed up the docs for the method because a combination is a different thing than a permutation but the Bevy docs seemed to use them interchangeably.