quick doc

pydata · Nov 21, 2017 · d1e1b8d · d1e1b8d
1 parent c8997c7
commit d1e1b8d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/doc/api-hidden.rst b/doc/api-hidden.rst
@@ -46,6 +46,7 @@
    Dataset.T
    Dataset.cumsum
    Dataset.cumprod
+   Dataset.rank
 
    DataArray.ndim
    DataArray.shape
@@ -91,6 +92,7 @@
    DataArray.T
    DataArray.cumsum
    DataArray.cumprod
+   DataArray.rank
 
    ufuncs.angle
    ufuncs.arccos

diff --git a/doc/api.rst b/doc/api.rst
@@ -160,6 +160,7 @@ Computation
 :py:attr:`~Dataset.real`
 :py:attr:`~Dataset.cumsum`
 :py:attr:`~Dataset.cumprod`
+:py:attr:`~Dataset.rank`
 
 **Grouped operations**:
 :py:attr:`~core.groupby.DatasetGroupBy.assign`
@@ -312,6 +313,7 @@ Computation
 :py:attr:`~DataArray.T`
 :py:attr:`~DataArray.cumsum`
 :py:attr:`~DataArray.cumprod`
+:py:attr:`~DataArray.rank`
 
 **Grouped operations**:
 :py:attr:`~core.groupby.DataArrayGroupBy.assign_coords`

diff --git a/doc/whats-new.rst b/doc/whats-new.rst
@@ -208,6 +208,10 @@ Enhancements
   (:issue:`1485`).
   By `Joe Hamman <https://github.com/jhamman>`_.
 
+- New :py:meth:`~xarray.DataArray.rank` method to Datasets and DataArrays when
+  bottleneck is available (:issue:`1731`).
+  By `0x0L <https://github.com/0x0L>`_.
+
 **Performance improvements**
 
 - :py:func:`~xarray.concat` was computing variables that aren't in memory