Fix typos in documentation

Author: Tokazama

Project.toml

@@ -1,7 +1,7 @@
 name = "AxisIndices"
 uuid = "f52c9ee2-1b1c-4fd8-8546-6350938c7f11"
 authors = ["Tokazama <[email protected]>"]
-version = "0.3.8"
+version = "0.3.9"
 
 [deps]
 ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"

docs/src/axis.md

@@ -147,7 +147,3 @@ However, it's still a little over twice as slow as normal indexing.
 That's largely because of the cost of searching `1.0:4.0` (which is a `StepRangeLen` type in this case).
 The second benchmark demonstrates how close we really are to standard indexing given similar range types.
 
-## Resizing Axes
-
-These methods help with operations that need to resize axes, either dynamically or by creating a new instance of an axis. In addition to helping with operations related to array resizing, these may be useful for managing the axis of a vector throughout a `push!`, `pushfirst!`, `pop`, and `popfirst!` operation.
-

docs/src/compatibility.md

@@ -13,7 +13,8 @@ In other words, the current version can only support multi-mapping multiple `Abs
 
 ## NamedDims
 
-[NamedDims.jl](https://github.com/invenia/NamedDims.jl)
+Indexing via named dimensions is supported via the [NamedDims.jl](https://github.com/invenia/NamedDims.jl) package.
+[`NIArray`](@ref) assists in constructing arrays that have both named dimensions and a subtype of `AbstractAxis` along each axis.
 
 ## OffsetArrays
 

docs/src/internal_api.md

@@ -41,4 +41,6 @@ AxisIndices.is_key
 AxisIndices.to_index
 AxisIndices.to_keys
 AxisIndices.get_factorization
+AxisIndices.is_simple_axis
+
 ```

docs/src/internals_of_indexing.md

@@ -67,5 +67,5 @@ Therefore, new subtypes of `AxisIndicesStyle` must define a `to_index` and `to_k
 
 
 [^1]: There's absolutely no functionality provided from `Base.to_index` that isn't already available with `AxisIndices.to_index`. Providing a seperate implementation is meant to avoid causing any unecessary ambiguities in this or any other packages that may be simultaneously loaded.
-[^2]: Why do we need the `index` produced in the previous `to_index` method to reconstruct keys? Technically we don't, but it allows use to avoid looking up indices a second time and ensuring they are inbounds.
+[^2]: Why do we need the `index` produced in the previous `to_index` method to reconstruct keys? Technically we don't, but it avoids looking up indices a second time and ensuring they are inbounds.
 [^3]: It is at this point that `unsafe_reconstruct` is called. This is only important to know if you want to create a new axis type that has keys that require some unique procedure to reconstruct.

docs/src/standard_library_api.md

@@ -6,6 +6,7 @@ rot180
 rotr90
 rotl90
 deleteat!
+reshape
 svd
 qr
 lu

src/AxisCore/reduce.jl

@@ -1,3 +1,4 @@
+
 """
     reduce_axis(axis[, new_indics]) -> AbstractAxis
 

src/AxisCore/reshape.jl

@@ -1,22 +1,21 @@
-#=
 """
+    reshape(A::AbstractAxisIndices, shape)
+
+Reshape the array and axes of `A`.
+
+## Examples
 ```jldoctest
+julia> using AxisIndices
+
 julia> A = reshape(AxisIndicesArray(Vector(1:8), [:a, :b, :c, :d, :e, :f, :g, :h]), 4, 2);
 
 julia> axes(A)
-(Axis([:a, :b, :c, :d]), SimpleAxis(OneTo(2)))
+(Axis([:a, :b, :c, :d] => Base.OneTo(4)), SimpleAxis(Base.OneTo(2)))
 
 julia> axes(reshape(A, 2, :))
-(Axis([:a, :b]), SimpleAxis(OneTo(4)))
+(Axis([:a, :b] => Base.OneTo(2)), SimpleAxis(Base.OneTo(4)))
+```
 """
-=#
-#=
-function Base.reshape(A::AbstractAxisIndices, shp::Tuple{Vararg{Union{Colon, Int64},N}}) where {N}
-    p = reshape(parent(A), shp)
-    return unsafe_reconstruct(A, p, reshape_axes(A, axes(p)))
-end
-=#
-
 function Base.reshape(A::AbstractAxisIndices, shp::NTuple{N,Int}) where {N}
     p = reshape(parent(A), shp)
     return unsafe_reconstruct(A, p, reshape_axes(naxes(A, Val(N)), axes(p)))

src/Math/lu.jl

@@ -32,10 +32,10 @@ julia> keys.(axes(F.L * F.U))
 ```
 """ lu
 
-function LinearAlgebra.lu!(a::AxisIndicesArray, args...; kwargs...)
-    inner_lu = lu!(parent(a), args...; kwargs...)
+function LinearAlgebra.lu!(A::AbstractAxisIndices, args...; kwargs...)
+    inner_lu = lu!(parent(A), args...; kwargs...)
     return LU(
-        AxisIndicesArray(getfield(inner_lu, :factors), axes(a)),
+        unsafe_reconstruct(A, getfield(inner_lu, :factors), axes(A)),
         getfield(inner_lu, :ipiv),
         getfield(inner_lu, :info)
        )

src/Math/svd.jl

@@ -34,7 +34,7 @@ function LinearAlgebra.svd(A::AbstractAxisIndices, args...; kwargs...)
     return AxisIndicesSVD(svd(parent(A), args...; kwargs...), A)
 end
 
-function LinearAlgebra.svd!(A::AxisIndicesArray, args...; kwargs...)
+function LinearAlgebra.svd!(A::AbstractAxisIndices, args...; kwargs...)
     return AxisIndicesSVD(svd!(parent(A), args...; kwargs...), A)
 end