Skip to content

Commit 523df6a

Browse files
committed
Update docstrings
1 parent bfcb8df commit 523df6a

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

  • simpeg/dask/potential_fields

simpeg/dask/potential_fields/base.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,11 @@ def storage_formatter(
6262
Format the storage of the sensitivity matrix.
6363
6464
:param rows: List of dask arrays representing blocks of the sensitivity matrix.
65-
:param device: Storage option, either "forward_only", "disk", or "memory".
66-
:param chunk_format: Chunking format for disk storage, either "row", "equal
67-
or "auto".
68-
:param sens_name: File path to store the sensitivity matrix if device is "disk".
69-
:param max_chunk_size: Maximum chunk size in MiB for disk storage.
70-
:param compute: If True, compute the dask array before returning.
65+
:param count: Current row count offset.
66+
:param j_matrix: Zarr array to store the sensitivity matrix on disk, if applicable
67+
68+
:return: If j_matrix is provided, returns None after storing the rows; otherwise,
69+
returns the stacked rows as a NumPy array.
7170
"""
7271

7372
if isinstance(j_matrix, zarr.Array):

0 commit comments

Comments
 (0)