Skip to content
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.

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

AxisTensors have no documentation #1994

Open
Tracked by #1995
Sbozzolo opened this issue Sep 17, 2024 · 1 comment
Open
Tracked by #1995

AxisTensors have no documentation #1994

Sbozzolo opened this issue Sep 17, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@Sbozzolo
Copy link
Member

Searching axistensors in the docs
image

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 Sbozzolo added bug Something isn't working documentation Improvements or additions to documentation labels Sep 17, 2024
@valentinaschueller
Copy link

The same seems to be the case for FieldVector: Not part of the Fields API documentation but there seems to be in-code documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants