Skip to content

Fix and improve MSAA documentation#16196

Merged
alice-i-cecile merged 2 commits intobevyengine:mainfrom
Jondolf:fix-msaa-docs
Oct 31, 2024
Merged

Fix and improve MSAA documentation#16196
alice-i-cecile merged 2 commits intobevyengine:mainfrom
Jondolf:fix-msaa-docs

Conversation

@Jondolf
Copy link
Copy Markdown
Contributor

@Jondolf Jondolf commented Oct 31, 2024

Objective

#14273 changed Msaa to be a component rather than a resource. However, the documentation still says that it is a resource. This tripped me up during migration to 0.15 until I looked at the type definition.

Additionally, the docs have some unnecessary repetition and some grammar mistakes, and they don't link to camera documentation.

Solution

Fix up the docs!

@Jondolf Jondolf added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Rendering Drawing game state to the screen S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 31, 2024
@alice-i-cecile alice-i-cecile added this to the 0.15 milestone Oct 31, 2024
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 31, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 31, 2024
Merged via the queue into bevyengine:main with commit 4656698 Oct 31, 2024
mockersf pushed a commit that referenced this pull request Nov 5, 2024
# Objective

#14273 changed `Msaa` to be a component rather than a resource. However,
the documentation still says that it is a resource. This tripped me up
during migration to 0.15 until I looked at the type definition.

Additionally, the docs have some unnecessary repetition and some grammar
mistakes, and they don't link to camera documentation.

## Solution

Fix up the docs!
ecoskey pushed a commit to ecoskey/bevy that referenced this pull request Jan 6, 2025
# Objective

bevyengine#14273 changed `Msaa` to be a component rather than a resource. However,
the documentation still says that it is a resource. This tripped me up
during migration to 0.15 until I looked at the type definition.

Additionally, the docs have some unnecessary repetition and some grammar
mistakes, and they don't link to camera documentation.

## Solution

Fix up the docs!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants