[Merged by Bors] - Document collide args #2721
Closed
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
rukai
force-pushed
the
document_collide
branch
2 times, most recently
from
2d7bd41
to
5e04005
Compare
|
I like that suggestion! Makes it very clear how to use. |
alice-i-cecile
added
C-Docs
alice-i-cecile
approved these changes
Aug 24, 2021
ghost
approved these changes
Aug 24, 2021
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
bors r+ |
|
Would something like /// # Arguments
///
/// * `a_pos` - Center-position of the first rectangle,
/// * `a_size` - Size of the first rectangle in height; width
/// * `b_pos` - Center-position of the second rectangle
/// * `b_size` - Size of the second rectangle in height; widthbe too much or would it be useful? |
|
We don't see "structured" argument docs like that very often in rust docs. Generally they are documented free-form in sentences. I think there are arguments to be made for both approaches, but given that this goes against a pattern we currently use, it should probably be discussed separately. |
bors bot
pushed a commit
that referenced
this pull request
Aug 24, 2021
Fixes #2720 (comment) Possibly we should omit the extra bit in brackets, not sure if its warranted.
bors
bot
changed the title
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.
Fixes #2720 (comment)
Possibly we should omit the extra bit in brackets, not sure if its warranted.