From 586ac48bd72e1a22c33f236ac00c24f792cc7998 Mon Sep 17 00:00:00 2001
From: Stepan Koltsov <stepan.koltsov@gmail.com>
Date: Sun, 18 Feb 2024 05:34:45 +0000
Subject: [PATCH] Clarify documentation of RaycastMesh::intersections (#104)

Co-authored-by: Aevyrie <aevyrie@gmail.com>
---
 src/deferred.rs | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/deferred.rs b/src/deferred.rs
index ef799dc..49a1eff 100644
--- a/src/deferred.rs
+++ b/src/deferred.rs
@@ -164,8 +164,12 @@ pub struct RaycastMesh<T: TypePath> {
 }
 
 impl<T: TypePath> RaycastMesh<T> {
-    /// Get a reference to the ray cast source's intersections. Returns an empty list if there are
-    /// no intersections.
+    /// Get a reference to the ray cast source's intersections.
+    ///
+    /// Here the [`Entity`] is the entity of the [`RaycastSource`] component.
+    /// Returns the list of intersections with all the sources with matching generic parameter
+    /// that intersected this mesh during the last raycast system run.
+    /// Returns an empty list if there are no intersections.
     pub fn intersections(&self) -> &[(Entity, IntersectionData)] {
         &self.intersections
     }