documentation changes

arviz-devs · Aug 12, 2020 · 19ac99a · 19ac99a
1 parent c78c2ad
commit 19ac99a
Showing 1 changed file with 18 additions and 2 deletions.
diff --git a/arviz/data/inference_data.py b/arviz/data/inference_data.py
@@ -450,8 +450,24 @@ def stack(
 
         Examples
         --------
-        Use ``stack`` to stack any number of existing dimensions into a single new dimension. We first check the
-        original object:
+        Use ``stack`` to stack any number of existing dimensions into a single new dimension.
+        We first check the original object:
+
+        .. ipython::
+
+            In [1]: import arviz as az
+               ...: idata = az.load_arviz_data("rugby")
+               ...: idata
+
+        In order to stack two dimensions ``chain`` and ``draw`` to ``sample``, we can use:
+
+        .. ipython::
+
+            In [1]: idata.stack(sample=["chain", "draw"], inplace=True)
+               ...: idata
+
+        We can also take the example of custom InferenceData object and perform stacking. We first
+        check the original object:
 
         .. ipython::