Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add docs to WindowDescriptor #4753

Closed
alice-i-cecile opened this issue May 15, 2022 · 0 comments
Closed

Add docs to WindowDescriptor #4753

alice-i-cecile opened this issue May 15, 2022 · 0 comments
Labels
A-Windowing Platform-agnostic interface layer to run your app in C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

alice-i-cecile commented May 15, 2022 •
edited
Loading

How can Bevy's documentation be improved?

WindowDescriptor has no docs. It is a very important struct for beginners, because it's used for common tasks like setting the screen size and changing the PresentMode.

Each of the fields should have their own documentation.
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Windowing Platform-agnostic interface layer to run your app in labels May 15, 2022
@object71 object71 mentioned this issue May 16, 2022
Closed
bors bot pushed a commit that referenced this issue May 17, 2022
@object71
Add documentation to the WindowDescriptor struct. (#4764)
b72fbfe 
# 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 bors bot closed this as completed in 6a23837 May 30, 2022
james7132 pushed a commit to james7132/bevy that referenced this issue Jun 7, 2022
@object71 @james7132
Add documentation to the WindowDescriptor struct. (bevyengine#4764)
9f4caca 
# 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.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this issue Feb 1, 2023
@object71 @ItsDoot
Add documentation to the WindowDescriptor struct. (bevyengine#4764)
2d94217 
# 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Windowing Platform-agnostic interface layer to run your app in C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Merged by Bors] - Add documentation to the WindowDescriptor struct. object71/bevy
1 participant
@alice-i-cecile