Added Documentation to all_tuples_with_size
#14832
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also updated the existing documentation of `all_tuples` to reference `all_tuples_with_size`, and pretty its formatting. Examples for `all_tuples_with_size` match `all_tuples` to highlight how the two helper macros compliment each other.
bushrat011899
force-pushed
the
Document_all_tuples_with_size
branch
from
c20aa3a
to
6ad5f90
Compare
bushrat011899
added
C-Docs
alice-i-cecile
approved these changes
Aug 20, 2024
alice-i-cecile
added
the
S-Waiting-on-Author
Just want to make sure CI fully passed first (which it hasn't quite yet!). Just thought I'd put this up in draft in the meantime so it could be looked through while we wait. |
Also updated the existing documentation of `all_tuples` to reference `all_tuples_with_size`, and pretty its formatting. Examples for `all_tuples_with_size` match `all_tuples` to highlight how the two helper macros compliment each other.
…shrat011899/bevy into Document_all_tuples_with_size
bushrat011899
removed
the
S-Waiting-on-Author
TrialDragon
added
the
S-Needs-Review
ItsDoot
approved these changes
Aug 20, 2024
alice-i-cecile
added
S-Ready-For-Final-Review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Solution
all_tuples_with_sizebased on existingall_tuplesdocumentation.all_tuplesdocumentation to match formatting of and link back toall_tuples_with_sizeTesting
Notes
Formatting changes I have proposed make the documentation a little cleaner in my opinion, but I am open to reverting them and amending
all_tuples_with_sizeto match if there are any reasonable objections.