Merge pull request xtensor-stack#2425 from tdegeus/docs

Updating docs argmin and argmax
DerThorsten · Aug 23, 2021 · cc23f11 · cc23f11
2 parents 2618d5a + 89e3b9f
commit cc23f11
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/include/xtensor/xsort.hpp b/include/xtensor/xsort.hpp
@@ -861,10 +861,12 @@ namespace xt
     }
 
     /**
-     * Find position of minimal value in xexpression
+     * Find position of minimal value in xexpression.
+     * By default, the returned index is into the flattened array.
+     * If `axis` is specified, the indices are along the specified axis.
      *
      * @param e input xexpression
-     * @param axis select axis (or none)
+     * @param axis select axis (optional)
      *
      * @return returns xarray with positions of minimal value
      */
@@ -887,9 +889,11 @@ namespace xt
 
     /**
      * Find position of maximal value in xexpression
+     * By default, the returned index is into the flattened array.
+     * If `axis` is specified, the indices are along the specified axis.
      *
      * @param e input xexpression
-     * @param axis select axis (or none)
+     * @param axis select axis (optional)
      *
      * @return returns xarray with positions of maximal value
      */