Skip to content

Commit 3b69401

Browse files
committed
Flesh out docstring
1 parent e71d12a commit 3b69401

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

conda_package/mpas_tools/ocean/barotropic_streamfunction.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,23 @@ def compute_barotropic_streamfunction(ds_mesh, ds, logger=None,
2121
A dataset containing MPAS mesh variables
2222
2323
ds : ``xarray.Dataset``
24-
A dataset containing MPAS output variables
24+
A dataset containing MPAS output variables ``normalVelocity`` and
25+
``layerThickness`` (possibly with a ``prefix``)
2526
2627
logger : ``logging.Logger``, optional
2728
A logger for the output if not stdout
2829
2930
min_depth : float, optional
30-
The minimum depth to compute transport over
31+
The minimum depth (positive down) to compute transport over
3132
3233
max_depth : float, optional
33-
The maximum depth to compute transport over
34+
The maximum depth (positive down) to compute transport over
35+
36+
prefix : str, optional
37+
The prefix on the ``normalVelocity`` and ``layerThickness`` variables
38+
39+
time_index : int, optional
40+
The time at which to index ``ds`` (if it has ``Time`` as a dimension)
3441
"""
3542

3643
useStdout = logger is None

0 commit comments

Comments
 (0)