Skip to content

Commit

Permalink
Flesh out docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
xylar committed Nov 13, 2024
1 parent 6fa6abf commit 9e92f02
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions conda_package/mpas_tools/ocean/barotropic_streamfunction.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,23 @@ def compute_barotropic_streamfunction(ds_mesh, ds, logger=None,
A dataset containing MPAS mesh variables
ds : ``xarray.Dataset``
A dataset containing MPAS output variables
A dataset containing MPAS output variables ``normalVelocity`` and
``layerThickness`` (possibly with a ``prefix``)
logger : ``logging.Logger``, optional
A logger for the output if not stdout
min_depth : float, optional
The minimum depth to compute transport over
The minimum depth (positive down) to compute transport over
max_depth : float, optional
The maximum depth to compute transport over
The maximum depth (positive down) to compute transport over
prefix : str, optional
The prefix on the ``normalVelocity`` and ``layerThickness`` variables
time_index : int, optional
The time at which to index ``ds`` (if it has ``Time`` as a dimension)
"""

useStdout = logger is None
Expand Down

0 comments on commit 9e92f02

Please sign in to comment.