Skip to content

Commit cc23f11

Browse files
authored
Merge pull request #2425 from tdegeus/docs
Updating docs argmin and argmax
2 parents 2618d5a + 89e3b9f commit cc23f11

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

include/xtensor/xsort.hpp

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -861,10 +861,12 @@ namespace xt
861861
}
862862

863863
/**
864-
* Find position of minimal value in xexpression
864+
* Find position of minimal value in xexpression.
865+
* By default, the returned index is into the flattened array.
866+
* If `axis` is specified, the indices are along the specified axis.
865867
*
866868
* @param e input xexpression
867-
* @param axis select axis (or none)
869+
* @param axis select axis (optional)
868870
*
869871
* @return returns xarray with positions of minimal value
870872
*/
@@ -887,9 +889,11 @@ namespace xt
887889

888890
/**
889891
* Find position of maximal value in xexpression
892+
* By default, the returned index is into the flattened array.
893+
* If `axis` is specified, the indices are along the specified axis.
890894
*
891895
* @param e input xexpression
892-
* @param axis select axis (or none)
896+
* @param axis select axis (optional)
893897
*
894898
* @return returns xarray with positions of maximal value
895899
*/

0 commit comments

Comments
 (0)