Merge pull request #161 from singularitti/patch-2

Update examples of `otherdims` & `commondims`

src/primitives.jl

@@ -76,6 +76,20 @@ This is basically `dims(x, lookup)` where the order of the original is kept,
 unlike [`dims`](@ref) where the lookup tuple determines the order
 
 Also unlike `dims`,`commondims` always returns a `Tuple`, no matter the input.
+```jldoctest
+julia> using DimensionalData
+
+julia> A = DimArray(ones(10, 10, 10), (X, Y, Z));
+
+julia> commondims(A, X)
+(X: Base.OneTo(10) (NoIndex),)
+
+julia> commondims(A, (X, Z))
+(X: Base.OneTo(10) (NoIndex), Z: Base.OneTo(10) (NoIndex))
+
+julia> commondims(A, Ti)
+()
+```
 """
 @inline commondims(A::AbstractArray, B::AbstractArray) = commondims(dims(A), dims(B))
 @inline commondims(A::AbstractArray, lookup) = commondims(dims(A), lookup)
@@ -332,6 +346,14 @@ julia> using DimensionalData
 
 julia> A = DimArray(ones(10, 10, 10), (X, Y, Z));
 
+julia> otherdims(A, X)
+(Y: Base.OneTo(10) (NoIndex), Z: Base.OneTo(10) (NoIndex))
+
+julia> otherdims(A, (Y, Z))
+(X: Base.OneTo(10) (NoIndex),)
+
+julia> otherdims(A, Ti)
+(X: Base.OneTo(10) (NoIndex), Y: Base.OneTo(10) (NoIndex), Z: Base.OneTo(10) (NoIndex))
 ```
 """
 @inline otherdims(A::AbstractArray, lookup) = otherdims(dims(A), lookup)