-
-
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] - Document collide args #2721
Conversation
2d7bd41
to
5e04005
Compare
I like that suggestion! Makes it very clear how to use. |
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; width be 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. |
Fixes #2720 (comment) Possibly we should omit the extra bit in brackets, not sure if its warranted.
Fixes #2720 (comment)
Possibly we should omit the extra bit in brackets, not sure if its warranted.