chore(docs): improve

jeertmans · Jan 16, 2025 · 9f9f445 · 9f9f445
1 parent c66d0db
commit 9f9f445
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/differt/src/differt/geometry/_paths.py b/differt/src/differt/geometry/_paths.py
@@ -202,6 +202,11 @@ def mask_duplicate_objects(self, axis: int = -1) -> Self:
         Args:
             axis: The batch axis along which the unique values are computed.
 
+                It defaults to the last axis, which is the axis where
+                different path candidates are stored when generating
+                paths with
+                :meth:`TriangleScene.compute_paths<differt.scene.TriangleScene.compute_paths>`.
+
         Returns:
             A new paths instance with masked duplicate objects.
 

diff --git a/differt/src/differt/scene/_triangle_scene.py b/differt/src/differt/scene/_triangle_scene.py
@@ -863,6 +863,14 @@ def compute_paths(  # noqa: C901
             The paths, as class wrapping path vertices, object indices, and a masked
             identify valid paths.
 
+            The returned paths have the following batch dimensions:
+
+            * ``[*transmitters_batch *receivers_batch num_path_candidates]``,
+            * ``[*transmitters_batch *receivers_batch chunk_size]``,
+            * or ``[*transmitters_batch *receivers_batch num_rays]``,
+
+            depending on the method used.
+
         Raises:
             ValueError: If neither ``order`` nor ``path_candidates`` has been provided,
                 or if both have been provided simultaneously.