Skip to content

Commit

Permalink
corrected docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ESadek-MO committed Nov 30, 2023
1 parent cf617c3 commit 91be20c
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions esmf_regrid/experimental/unstructured_scheme.py
Original file line number Diff line number Diff line change
Expand Up @@ -382,11 +382,8 @@ def regrid_unstructured_to_unstructured(
target cell. ``mdtol=0`` means no missing data is tolerated while ``mdtol=1``
will mean the resulting element will be masked if and only if all the
overlapping cells of the ``src_cube`` are masked.
method : str, default="conservative"
Either "conservative", "bilinear" or "nearest". Corresponds to the :mod:`esmpy` methods
:attr:`~esmpy.api.constants.RegridMethod.CONSERVE` or
:attr:`~esmpy.api.constants.RegridMethod.BILINEAR` or
:attr:`~esmpy.api.constants.RegridMethod.NEAREST` used to calculate weights.
method : :class:`Constants.Method`, default=Constants.Method.CONSERVATIVE
The method used to calculate weights.
use_src_mask : :obj:`~numpy.typing.ArrayLike` or bool, default=False
Either an array representing the cells in the source to ignore, or else
a boolean value. If True, this array is taken from the mask on the data
Expand Down

0 comments on commit 91be20c

Please sign in to comment.