Skip to content

Deprecated Docstring: transpose(::Vec) is discontinued but transpose docstring does not reflect this #226

@jfdev001

Description

@jfdev001

The docstring for transpose at

transpose(::Vec)

suggests that transpose is defined for Tensors.Vec, but this is not the case given

for f in (:transpose, :adjoint)
    @eval function LinearAlgebra.$f(::Vec)
        throw(ArgumentError("the (no-op) $($f) is discontinued for `Tensors.Vec`"))
    end
end

from src/tensor_ops_errors.jl:#L8

A simple fix would be to remove transpose(::Vec) from thesrc/transpose.jl docstring so that the new docstring is

"""
    transpose(::SecondOrderTensor)
    transpose(::FourthOrderTensor)

Compute the transpose of a tensor.
For a fourth order tensor, the transpose is the minor transpose.
...
"""

I can open a PR to fix this, but wanted to open an issue first.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions