add docstrings

Author: rokke

src/array_partition.jl

@@ -723,5 +723,27 @@ function Adapt.adapt_structure(to, ap::ArrayPartition)
     return ArrayPartition(map(x -> Adapt.adapt(to, x), ap.x)...)
 end
 
+"""
+```julia
+AP[ matrices, ]
+```
+
+Create an `ArrayPartition` using vector syntax. Equivalent to `ArrayPartition(matrices)`, but looks nicer with nesting.
+
+# Examples:
+
+Simple examples:
+```julia
+ArrayPartition([1,2,3], [1 2;3 4]) == AP[[1,2,3], [1 2;3 4]] # true
+AP[1u"m/s^2", 1u"m/s", 1u"m"]
+```
+
+With an ODEProblem:
+```julia
+func(u, p, t) = AP[5u.x[1], u.x[2]./2]
+ODEProblem(func, AP[ [1.,2.,3.], [1. 2.;3. 4.] ], (0, 1)) |> solve
+```
+
+"""
 struct AP end
 Base.getindex(::Type{AP}, xs...) = ArrayPartition(xs...)

src/vector_of_array.jl

@@ -1656,5 +1656,30 @@ end
 unpack_args_voa(i, args::Tuple{Any}) = (unpack_voa(args[1], i),)
 unpack_args_voa(::Any, args::Tuple{}) = ()
 
+"""
+```julia
+VA[ matrices, ]
+```
+
+Create an `VectorOfArray` using vector syntax. Equivalent to `VectorOfArray([matrices])`, but looks nicer with nesting.
+
+# Simple example:
+```julia
+VectorOfArray([[1,2,3], [1 2;3 4]]) == VA[[1,2,3], [1 2;3 4]] # true
+```
+
+# All the layers:
+```julia
+nested = VA[
+    fill(1, 2, 3),
+    VA[
+        VA[8, [1, 2, 3], [1 2;3 4], VA[1, 2, 3]],
+        fill(2, 3, 4),
+        VA[3ones(3), zeros(3)],
+    ],
+]
+```
+
+"""
 struct VA end
 Base.getindex(::Type{VA}, xs...) = VectorOfArray(collect(xs))