docstring, whatsnew

pydata · Mar 4, 2020 · 134db2d · 134db2d
1 parent d7cac81
commit 134db2d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/doc/whats-new.rst b/doc/whats-new.rst
@@ -36,16 +36,16 @@ New Features
   By `Justus Magin <https://github.com/keewis>`_.
 - :py:meth:`Dataset.groupby` and :py:meth:`DataArray.groupby` now raise a 
   `TypeError` on multiple string arguments. Receiving multiple string arguments
-  often means a user is attempting to pass multiple dimensions as seeparate
-  argument and should instead pass a list.
+  often means a user is attempting to pass multiple dimensions as separate
+  arguments and should instead pass a single list of dimensions.
   (:pull:`3802`)
   By `Maximilian Roos <https://github.com/max-sixty>`_
 - The new ``Dataset._repr_html_`` and ``DataArray._repr_html_`` (introduced
   in 0.14.1) is now on by default. To disable, use
   ``xarray.set_options(display_style="text")``.
   By `Julia Signell <https://github.com/jsignell>`_.
 - An ellipsis (``...``) is now supported in the ``dims`` argument of
-  :py:meth:`Dataset.stack` and :py:meth:`DataArray.stack` to mean all
+  :py:meth:`Dataset.stack` and :py:meth:`DataArray.stack`, meaning all
   dimensions, similar to its meaning in :py:meth:`DataArray.transpose`
   (:pull:`3826`)
   By `Maximilian Roos <https://github.com/max-sixty>`_

diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py
@@ -1705,7 +1705,8 @@ def stack(
         ----------
         dimensions : Mapping of the form new_name=(dim1, dim2, ...)
             Names of new dimensions, and the existing dimensions that they
-            replace.
+            replace. Passing a list with an ellipsis (`[...]`) will stack over all
+            dimensions.
         **dimensions_kwargs:
             The keyword arguments form of ``dimensions``.
             One of dimensions or dimensions_kwargs must be provided.

diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py
@@ -3279,7 +3279,8 @@ def stack(
         ----------
         dimensions : Mapping of the form new_name=(dim1, dim2, ...)
             Names of new dimensions, and the existing dimensions that they
-            replace.
+            replace. Passing a list with an ellipsis (`[...]`) will stack over all
+            dimensions.
         **dimensions_kwargs:
             The keyword arguments form of ``dimensions``.
             One of dimensions or dimensions_kwargs must be provided.