Skip to content

Commit 82af824

Browse files
committed
Add missing docs page
1 parent e259291 commit 82af824

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/src/symbolic_units.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Symbolic Dimensions
2+
3+
Whereas `u"..."` will automatically convert all units to the same
4+
base SI units, `us"..."` will not. This uses the `SymbolicDimensions`
5+
type, which is a subtype of `AbstractDimensions` that stores the
6+
dimensions symbolically. This is useful for keeping track of the
7+
original units and constants in a user-entered expression.
8+
9+
The two main functions for working with symbolic
10+
units are `sym_uparse` and `us_str`:
11+
12+
```@docs
13+
@us_str
14+
sym_uparse
15+
```
16+
17+
To convert a quantity to its regular base SI units, use `expand_units`:
18+
19+
```@docs
20+
expand_units
21+
```

0 commit comments

Comments
 (0)