improve documentation relating to WindowPlugin and Window
#9173
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
- attempt to clarify with better docstrings the default behaviour of WindowPlugin and the component type it accepts.
|
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
Selene-Amanita
suggested changes
Jul 16, 2023
Selene-Amanita
added
C-Docs
Co-authored-by: Sélène Amanita <134181069+Selene-Amanita@users.noreply.github.com>
Co-authored-by: Sélène Amanita <134181069+Selene-Amanita@users.noreply.github.com>
Selene-Amanita
approved these changes
Jul 18, 2023
mockersf
approved these changes
Jul 21, 2023
mockersf
added
the
S-Ready-For-Final-Review
cart
pushed a commit
that referenced
this pull request
Aug 10, 2023
- attempt to clarify with better docstrings the default behaviour of WindowPlugin and the component type it accepts. # Objective - I'm new to Rust and Bevy, I got a bit confused about how to customise some window parameters (title, height, width etc) and while the docs do show the struct code for that field `Option<Window>` I was a bit of a doofus and skipped that to read the docstring entry for `primary_window` and then the `Window` component directly which aren't linked together. This is a minor improvement which I think will help in-case others, like me, have a doofus moment. --------- Co-authored-by: Sélène Amanita <134181069+Selene-Amanita@users.noreply.github.com>
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
Option<Window>I was a bit of a doofus and skipped that to read the docstring entry forprimary_windowand then theWindowcomponent directly which aren't linked together. This is a minor improvement which I think will help in-case others, like me, have a doofus moment.