Ferrite-FEM / Ferrite-FEM/Tensors.jl

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

Aperta
#226 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Julia
Stelle
182
Fork
40
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The docstring for `transpose` at

https://github.com/Ferrite-FEM/Tensors.jl/blob/f1726ac8a1f9d88a6ee84ab4440617c598daaaea/src/transpose.jl#L3

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

```julia
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](https://github.com/Ferrite-FEM/Tensors.jl/blob/0376a81592c4c044134ac9041a5c2d69a383261a/src/tensor_ops_errors.jl#L8)

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

```julia
"""
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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.