From bf9971f23916d6b75911ca26f425ef268450dc7d Mon Sep 17 00:00:00 2001 From: Rich Churcher Date: Thu, 14 Nov 2024 09:42:53 +1300 Subject: [PATCH] Minor docs fixes (#16347) Happened upon a few stray characters while reading about picking. --- crates/bevy_picking/src/backend.rs | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/crates/bevy_picking/src/backend.rs b/crates/bevy_picking/src/backend.rs index 49567d47d6..6ddb1a7ffe 100644 --- a/crates/bevy_picking/src/backend.rs +++ b/crates/bevy_picking/src/backend.rs @@ -6,10 +6,10 @@ //! detail. //! //! Because `bevy_picking` is very loosely coupled with its backends, you can mix and match as -//! many backends as you want. For example, You could use the `rapier` backend to raycast against +//! many backends as you want. For example, you could use the `rapier` backend to raycast against //! physics objects, a picking shader backend to pick non-physics meshes, and the `bevy_ui` backend -//! for your UI. The [`PointerHits`]s produced by these various backends will be combined, sorted, -//! and used as a homogeneous input for the picking systems that consume these events. +//! for your UI. The [`PointerHits`] instances produced by these various backends will be combined, +//! sorted, and used as a homogeneous input for the picking systems that consume these events. //! //! ## Implementation //! @@ -22,7 +22,7 @@ //! //! - Backends do not need to consider the [`PickingBehavior`](crate::PickingBehavior) component, though they may //! use it for optimization purposes. For example, a backend that traverses a spatial hierarchy -//! may want to early exit if it intersects an entity that blocks lower entities from being +//! may want to exit early if it intersects an entity that blocks lower entities from being //! picked. //! //! ### Raycasting Backends @@ -49,9 +49,8 @@ pub mod prelude { /// An event produced by a picking backend after it has run its hit tests, describing the entities /// under a pointer. /// -/// Some backends may only support providing the topmost entity; this is a valid limitation of some -/// backends. For example, a picking shader might only have data on the topmost rendered output from -/// its buffer. +/// Some backends may only support providing the topmost entity; this is a valid limitation. For +/// example, a picking shader might only have data on the topmost rendered output from its buffer. /// /// Note that systems reading these events in [`PreUpdate`](bevy_app) will not report ordering /// ambiguities with picking backends. Take care to ensure such systems are explicitly ordered