Skip to content

Commit c1bdf62

Browse files
committed
Improve array docstring
1 parent 083ac0f commit c1bdf62

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

docs/src/types.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,16 @@ AbstractQuantity
1717
Note also that the `Quantity` object can take a custom `AbstractDimensions`
1818
as input, so there is often no need to subtype `AbstractQuantity` separately.
1919

20+
## Symbolic dimensions
21+
2022
Another type which subtypes `AbstractDimensions` is `SymbolicDimensions`:
2123

2224
```@docs
2325
SymbolicDimensions
2426
```
27+
28+
## Arrays
29+
30+
```@docs
31+
QuantityArray
32+
```

src/arrays.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import Compat: allequal
55
66
An array of quantities with value `value` of type `V` and dimensions `dimensions` of type `D`
77
(which are shared across all elements of the array). This is a subtype of `AbstractArray{Q,N}`,
8-
and so can be used in most places where a normal array would be used.
8+
and so can be used in most places where a normal array would be used, including broadcasting operations.
99
1010
# Fields
1111
12-
- `value`: The underlying array of values.
13-
- `dimensions`: The dimensions of the array.
12+
- `value`: The underlying array of values. Access with `ustrip(a)`.
13+
- `dimensions`: The dimensions of the array. Access with `dimension(a)`.
1414
1515
# Constructors
1616

0 commit comments

Comments
 (0)