Skip to content

Commit dd5dcc8

Browse files
committed
Update docstrings
1 parent b92ca0c commit dd5dcc8

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

base/reduce.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -828,7 +828,7 @@ When `domain` is omitted, `f` must have an implicit domain. In particular, if
828828
(domain) to values (codomain), i.e. `findmin(itr)` returns the minimal element
829829
of the collection `itr` and its index.
830830
831-
Values are compared with `isgreater`.
831+
`NaN` is treated as less than all other values except `missing`.
832832
833833
# Examples
834834
@@ -913,7 +913,7 @@ When `domain` is omitted, `f` must have an implicit domain. In particular, if
913913
(domain) to values (codomain), i.e. `argmin(itr)` returns the index of the
914914
minimal element in `itr`.
915915
916-
Values are compared with `isgreater`.
916+
`NaN` is treated as less than all other values except `missing`.
917917
918918
# Examples
919919
```jldoctest

base/reducedim.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -967,7 +967,7 @@ end
967967
968968
Find the minimum of `A` and the corresponding linear index along singleton
969969
dimensions of `rval` and `rind`, and store the results in `rval` and `rind`.
970-
`NaN` is treated as less than all other values.
970+
`NaN` is treated as less than all other values except `missing`.
971971
"""
972972
function findmin!(rval::AbstractArray, rind::AbstractArray, A::AbstractArray;
973973
init::Bool=true)
@@ -978,7 +978,7 @@ end
978978
findmin(A; dims) -> (minval, index)
979979
980980
For an array input, returns the value and index of the minimum over the given dimensions.
981-
`NaN` is treated as less than all other values.
981+
`NaN` is treated as less than all other values except `missing`.
982982
983983
# Examples
984984
```jldoctest
@@ -1014,7 +1014,7 @@ end
10141014
10151015
Find the maximum of `A` and the corresponding linear index along singleton
10161016
dimensions of `rval` and `rind`, and store the results in `rval` and `rind`.
1017-
`NaN` is treated as greater than all other values.
1017+
`NaN` is treated as greater than all other values except `missing`.
10181018
"""
10191019
function findmax!(rval::AbstractArray, rind::AbstractArray, A::AbstractArray;
10201020
init::Bool=true)
@@ -1025,7 +1025,7 @@ end
10251025
findmax(A; dims) -> (maxval, index)
10261026
10271027
For an array input, returns the value and index of the maximum over the given dimensions.
1028-
`NaN` is treated as greater than all other values.
1028+
`NaN` is treated as greater than all other values except `missing`.
10291029
10301030
# Examples
10311031
```jldoctest
@@ -1062,7 +1062,7 @@ reducedim1(R, A) = length(axes1(R)) == 1
10621062
argmin(A; dims) -> indices
10631063
10641064
For an array input, return the indices of the minimum elements over the given dimensions.
1065-
`NaN` is treated as less than all other values.
1065+
`NaN` is treated as less than all other values except `missing`.
10661066
10671067
# Examples
10681068
```jldoctest
@@ -1087,7 +1087,7 @@ argmin(A::AbstractArray; dims=:) = findmin(A; dims=dims)[2]
10871087
argmax(A; dims) -> indices
10881088
10891089
For an array input, return the indices of the maximum elements over the given dimensions.
1090-
`NaN` is treated as greater than all other values.
1090+
`NaN` is treated as greater than all other values except `missing`.
10911091
10921092
# Examples
10931093
```jldoctest

0 commit comments

Comments
 (0)