Skip to content

Commit 695311f

Browse files
committed
Update return type and docstrings
1 parent 38f3042 commit 695311f

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

simpeg_drivers/utils/utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@
4949

5050
def mask_vertices_and_cells(
5151
extent: np.ndarray, vertices: np.ndarray, cells: np.ndarray | None
52-
) -> tuple[np.ndarray, np.ndarray]:
52+
) -> tuple[np.ndarray, np.ndarray] | tuple[np.ndarray, None]:
5353
"""
5454
Mask vertices and remove cells whose vertices are all outside the extent.
5555
56-
:param extent: Array-like object of [[xmin, ymin], [xmax, ymax]].
56+
:param extent: Array of shape (2, 3) containing the lower SW and upper NE coordinates.
5757
:param vertices: Array of shape (n_vertices, 3) containing the x, y, z coordinates.
5858
:param cells: Array of shape (n_cells, 3) containing the indices of the vertices
5959
that make up each cell.

0 commit comments

Comments
 (0)