From 46566980a6d69d2bd91505b6acd49ababa4d98f7 Mon Sep 17 00:00:00 2001 From: Joona Aalto Date: Thu, 31 Oct 2024 23:34:04 +0200 Subject: [PATCH] Fix and improve MSAA documentation (#16196) # 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! --- crates/bevy_render/src/view/mod.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/crates/bevy_render/src/view/mod.rs b/crates/bevy_render/src/view/mod.rs index 2a6d966705..2e306d610f 100644 --- a/crates/bevy_render/src/view/mod.rs +++ b/crates/bevy_render/src/view/mod.rs @@ -146,14 +146,14 @@ impl Plugin for ViewPlugin { } } -/// Configuration resource for [Multi-Sample Anti-Aliasing](https://en.wikipedia.org/wiki/Multisample_anti-aliasing). +/// Component for configuring the number of samples for [Multi-Sample Anti-Aliasing](https://en.wikipedia.org/wiki/Multisample_anti-aliasing) +/// for a [`Camera`](crate::camera::Camera). /// -/// The number of samples to run for Multi-Sample Anti-Aliasing for a given camera. Higher numbers -/// result in smoother edges. +/// Defaults to 4 samples. A higher number of samples results in smoother edges. /// -/// Defaults to 4 samples. Some advanced rendering features may require that MSAA be disabled. +/// Some advanced rendering features may require that MSAA is disabled. /// -/// Note that web currently only supports 1 or 4 samples. +/// Note that the web currently only supports 1 or 4 samples. #[derive( Component, Default,