Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dcherian committed Apr 20, 2021
1 parent ca0f2a0 commit d857c36
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions cf_xarray/accessor.py
Original file line number Diff line number Diff line change
Expand Up @@ -1411,16 +1411,19 @@ def differentiate(
self, coord, *xr_args, positive_upward: bool = False, **xr_kwargs
):
"""
Differentiate an xarray object.
Parameters
----------
xr_args, xr_kwargs are passed directly to the underlying xarray function.
The following are added by cf_xarray:
positive_upward: optional, bool
Change sign of the derivative based on the ``"positive"`` attribute of ``coord``
so that positive values indicate increasing upward.
If ``positive=="down"``, then multiplied by -1.
Notes
-----
``xr_args``, ``xr_kwargs`` are passed directly to the underlying xarray function.
See Also
--------
DataArray.cf.differentiate
Expand Down
2 changes: 1 addition & 1 deletion doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Attributes
DataArray.cf.axes
DataArray.cf.cell_measures
DataArray.cf.coordinates
DataArray.cf.standard_names
DataArray.cf.formula_terms
DataArray.cf.standard_names
DataArray.cf.plot


Expand Down

0 comments on commit d857c36

Please sign in to comment.