Skip to content

Commit 2bdedc1

Browse files
ranochaandreasnoack
authored andcommitted
adapt docstring of dot: size -> axes
1 parent 5f2b9e1 commit 2bdedc1

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

stdlib/LinearAlgebra/src/generic.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -908,10 +908,10 @@ dot(x::Number, y::Number) = conj(x) * y
908908
dot(x, y)
909909
x ⋅ y
910910
911-
Compute the dot product between two arrays of the same size as if they were
912-
vectors. For complex arrays, the elements of the first array are conjugated.
911+
Compute the dot product between two arrays with the same [`axes`](@ref) as if they
912+
were vectors. For complex arrays, the elements of the first array are conjugated.
913913
This is the classical dot product for vectors and the Hilbert-Schmidt dot
914-
product `tr(x' * y)` for matrices. When the arrays have equal sizes, calling
914+
product `tr(x' * y)` for matrices. When the arrays have equal axes, calling
915915
`dot` is semantically equivalent to `sum(dot(vx,vy) for (vx,vy) in zip(x, y))`.
916916
917917
# Examples

0 commit comments

Comments
 (0)