Add functions from base/reducedim.jl to doc/base/src/arrays.md #29773
Conversation
thchr
force-pushed
the
array-manual-additions
branch
from
2c41444 to
14dd0ce
Compare
|
@fredrikekre : I wonder if I could request a review from you, given #29604 (comment). |
|
This is obviously not a crucial PR, but I thought I'd bump it anyway as I guess it is not likely to be a particularly controversial one either. |
| Base.findnext(::Function, ::Any, ::Integer) | ||
| Base.findprev(::Any, ::Integer) | ||
| Base.findprev(::Function, ::Any, ::Integer) | ||
| Base.findmin(::AbstractArray) |
There was a problem hiding this comment.
This method (and some others that you moved) work on e.g. tuples as well, but is this another docstring then?
There was a problem hiding this comment.
I added findmin and moved findmin!: the former indeed has other methods, but for the latter, I can only find a single method signature taking (::AbstractArray, ::AbstractArray, ::AbstractArray).
The methods I removed from collections.md (and then readded to arrays.md) only had ::AbstractArray-type signature variants.
Thanks for finding time to review this!
|
I did a spot check on many of these, and it seems like they are now in the documentation. Please reopen if not the case, or a new PR if some things are still missing. |
3 participants
This follows up on #29604 (comment): several of the doc-string'ed, exported functions (with
AbstractArrayinputs) frombase/reducedim.jlwere not included in the documentation, leading to doc-tests not being run.I think the reasoning behind the omissions is that identically-named functions are already listed in the section on iterable collections in
doc/src/base/collections.md---but those functions apply to generic iterables, so theAbstractArray-signature variants are not included. One of the downside of this is that doc-tests are not run for theAbstractArrayvariants.So, in this PR, I include all the doc-string'ed, exported functions from
base/reducedim.jlin thearrays.mddocumentation. In addition, I moved functions from thecollections.mddocumentation to thearrays.mddocumentation if their type-inputs only allowAbstractArray(maximum!,minimum!,findmin!,findmax!,any!,all!,sum!,prod!, ). This latter move is perhaps not a net positive, so please let me know if that seems meaningful or not.More broadly, let me know if the additions to
arrays.mdshould go elsewhere (files, subsections, etc.)