Doc IndexLinear and IndexCartesian #28476
Conversation
kshyatt
added
docs
kshyatt
changed the title
base/indices.jl
Outdated
| """ | ||
| IndexLinear() | ||
|
|
||
| Subtype of [`IndexStyle`](@ref) which specifies that the array it describes |
There was a problem hiding this comment.
Really nice. Here's a shot at a set of hopefully-slightly-clearer first sentences:
Subtype of
[`IndexStyle`](@ref)that is used to describe arrays that are optimally indexed by one linear index.
Subtype of
[`IndexStyle`](@ref)that is used to describe arrays that are optimally indexed by a Cartesian index with the same number of indices as there are dimensions in the array.
I also have a slight preference for separating out the first sentence in a docstring as a stand-alone "summary" line (a paragraph by itself).
|
Thanks for the feedback, guys. I'll get on this asap. |
base/indices.jl
Outdated
| either linear indexing or cartesian indexing. If you decide to | ||
| implement linear indexing, then you must set this trait for your array | ||
| you define a new [`AbstractArray`](@ref) type, you can choose to implement | ||
| either linear indexing (with [`IndexLinear`](@ref)) wor cartesian indexing. |
There was a problem hiding this comment.
“wor cartesian” should be “or Cartesian” (w + capital)
|
Good to go? Whoever merges, please remember to remove the |
* Doc IndexLinear and IndexCartesian (cherry picked from commit d15b091)
* Doc IndexLinear and IndexCartesian (cherry picked from commit d15b091)
* Doc IndexLinear and IndexCartesian (cherry picked from commit d15b091)
* Doc IndexLinear and IndexCartesian (cherry picked from commit d15b091)
* Doc IndexLinear and IndexCartesian (cherry picked from commit d15b091)
* Doc IndexLinear and IndexCartesian (cherry picked from commit d15b091)
Hopefully this is ok as a summary ... definitely open to suggestions for improvement!