Skip to content

Commit 318d1c3

Browse files
authored
Fix backticks and spacing in docstring
1 parent 6d818bb commit 318d1c3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/RecursiveArrayTools.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import Adapt
1717
An AbstractVectorOfArray is an object which represents arrays of arrays,
1818
and arbitrary recursive nesting of arrays, as a single array-like object.
1919
Thus a canonical example of an AbstractVectorOfArray is something of the
20-
form `VectorOfArray([[1,2],[3,4]])`, which "acts" like the matrix [1 3; 2 4]
20+
form `VectorOfArray([[1,2],[3,4]])`, which "acts" like the matrix `[1 3; 2 4]`
2121
where the data is stored and accessed in a column-ordered fashion (as is typical
2222
in Julia), but the actual matrix is never constructed and instead lazily represented
2323
through the type.
@@ -26,8 +26,8 @@ An AbstractVectorOfArray subtype should match the following behaviors.
2626
2727
!!! note
2828
29-
In 2023 the linear indexing `A[i]`` was deprecated. It previously had the behavior that `A[i] = A.u[i]`. However, this is incompatible with standard `AbstractArray`interfaces, Since if`A = VectorOfArray([[1,2],[3,4]])`and`A`is supposed to act like`[1 3; 2 4]`, then there is a difference `A[1] = [1,2]`for the VectorOfArray while`A[1] = 1`for the matrix. This causes many issues if`AbstractVectorOfArray <: AbstractArray`. Thus we plan in 2026 to complete the deprecation and thus have a breaking update where `A[i]`matches the linear indexing of an`AbstractArray`, and then making `AbstractVectorOfArray <: AbstractArray`. Until then, `AbstractVectorOfArray` due to
30-
this interface break but manually implements an AbstractArray-like interface for
29+
In 2023 the linear indexing `A[i]` was deprecated. It previously had the behavior that `A[i] = A.u[i]`. However, this is incompatible with standard `AbstractArray` interfaces, Since if `A = VectorOfArray([[1,2],[3,4]])` and `A` is supposed to act like `[1 3; 2 4]`, then there is a difference `A[1] = [1,2]` for the VectorOfArray while `A[1] = 1` for the matrix. This causes many issues if `AbstractVectorOfArray <: AbstractArray`. Thus we plan in 2026 to complete the deprecation and thus have a breaking update where `A[i]` matches the linear indexing of an`AbstractArray`, and then making `AbstractVectorOfArray <: AbstractArray`. Until then, `AbstractVectorOfArray` due to
30+
this interface break but manually implements an `AbstractArray`-like interface for
3131
future compatibility.
3232
3333
## Fields

0 commit comments

Comments
 (0)