[Merged by Bors] - Add documentation to the WindowDescriptor struct.#4764
[Merged by Bors] - Add documentation to the WindowDescriptor struct.#4764object71 wants to merge 12 commits intobevyengine:mainfrom
Conversation
object71
force-pushed
the
document-window-descriptor
branch
2 times, most recently
from
01342e4 to
f7e494a
Compare
alice-i-cecile
added
C-Docs
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
These are excellent docs. Some small nits, but this is nearly ready.
object71
force-pushed
the
document-window-descriptor
branch
from
cb5e626 to
1f10578
Compare
object71
force-pushed
the
document-window-descriptor
branch
from
1f10578 to
afdc97f
Compare
|
@bevyengine/docs-team can I get a second review? |
ghost
left a comment
ghost
left a comment
There was a problem hiding this comment.
Great work! Especially the comment on the struct itself will be really beneficial for a lot of users.
Co-Authored-By: Alice Cecile <alice.i.cecile@gmail.com>
object71
force-pushed
the
document-window-descriptor
branch
from
afdc97f to
a1e1770
Compare
|
Also added a short comment for decorations in the last change as it isn't descriptive at first glance (or at least for me). So I searched it in winit and found that it is responsible for borders and bars. |
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
Awesome, thanks again! BTW, in the future, prefer many small commits over rebasing when contributing here. We squash on merge, and the separate commits make it easier for reviewers to quickly check what's changed. |
|
bors r+ |
# Objective Resolves #4753 ## Solution Using rust doc I added documentation to the struct. Decided to not provide an example in the doc comment but instead refer to the example file that shows the usage.
|
Build failed: |
Ah, #4575 strikes again. Not your fault here. |
Ok, thanks for the guideline :) |
Nilirad
left a comment
Nilirad
left a comment
There was a problem hiding this comment.
This is a good improvement. Adding docs is always helpful to readers who want to learn more.
To my eyes this PR only needs some adjustments on what has been already changed. I specified them in the comments below.
Also, I feel that this needs some other additions, in particular to undocumented fields, because #4753 requires that all fields should be documented to be closed.
title,resizable,cursor_visible,cursor_locked,
have been probably left out because they are trivial, but a well thought short description is always helpful.
The fields:
resize_constraintspresent_modemode
are even easier to document, since a link to the type with a minimal description is sufficient.
Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>
Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>
… document-window-descriptor
Nilirad
left a comment
Nilirad
left a comment
There was a problem hiding this comment.
Great work with documenting all fields!
Once the wording suggestion below is applied, I will feel comfortable to approve this PR. 😄
Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>
|
I don't understand why it fails. Do I need to do something else? |
|
Not your fault; this was a flaky check that we've since removed. |
|
bors r+ |
# Objective Resolves #4753 ## Solution Using rust doc I added documentation to the struct. Decided to not provide an example in the doc comment but instead refer to the example file that shows the usage.
bors
bot
changed the title
# Objective Resolves bevyengine#4753 ## Solution Using rust doc I added documentation to the struct. Decided to not provide an example in the doc comment but instead refer to the example file that shows the usage.
# Objective Resolves bevyengine#4753 ## Solution Using rust doc I added documentation to the struct. Decided to not provide an example in the doc comment but instead refer to the example file that shows the usage.
5 participants
Objective
Resolves #4753
Solution
Using rust doc I added documentation to the struct. Decided to not provide an example in the doc comment but instead refer to the example file that shows the usage.