New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

`AxisTensor`s have no documentation #1994

Open

Tracked by

Sbozzolo opened this issue Sep 17, 2024 · 0 comments

Open

Tracked by

`AxisTensor`s have no documentation #1994

Sbozzolo opened this issue Sep 17, 2024 · 0 comments

Labels

bug documentation

Member

Sbozzolo commented Sep 17, 2024

Searching axistensors in the docs

Searching in the code base gives a little more

"""
    AxisTensor(axes, components)

An `AxisTensor` is a wrapper around a `StaticArray`, where each dimension is
labelled with an [`AbstractAxis`](@ref). These axes must be consistent for
operations such as addition or subtraction, or be dual to each other for
operations such as multiplication.


# See also
[`components`](@ref) to obtain the underlying array.
"""

this is not enough to understand what they are for and how to use them

Sbozzolo added bug documentation labels

Sbozzolo mentioned this issue

Critical documentation is missing #1995

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment