CliMA / CliMA/ClimaCore.jl

`AxisTensor`s have no documentation

Closed
#1,994 1 comment 0 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Julia
Stars
117
Forks
19
Avg merge
3d 4h
Merged PRs (30d)
41

Description

Searching axistensors in the docs
![image](https://github.com/user-attachments/assets/fca97ad4-13b9-496c-a866-262346b6247d)

Searching in the code base gives a little more
```julia
"""
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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by searching the documentation and codebase for `AxisTensor` and reviewing its existing docstring. Document what `AxisTensor`s are for and how to use them, including enough context beyond the current definition to make the concept understandable; the issue is complete when users can find and follow practical guidance in the docs.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.