Skip to content

Commit e099b1d

Browse files
committed
Finish renaming
1 parent 54cc371 commit e099b1d

File tree

5 files changed

+8
-7
lines changed

5 files changed

+8
-7
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,9 +207,9 @@ julia> expand_units(x^2)
207207
8.987551787368176e16 m² s⁻⁴
208208
```
209209

210-
You can also convert a quantity in regular base SI units to symbolic units with `as_units`:
210+
You can also convert a quantity in regular base SI units to symbolic units with `as_u`:
211211
```julia
212-
julia> as_units(5e-9u"m", us"nm") # can also write 5e-9u"m" |> as_units(us"nm")
212+
julia> as_u(5e-9u"m", us"nm") # can also write 5e-9u"m" |> as_u(us"nm")
213213
5.0 nm
214214
```
215215

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
DynamicQuantities = "06fc5a27-2a28-4c7c-a15d-362465fb6821"

docs/src/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ julia> p = sqrt(2 * m_e * (E - Φ)) # momentum of ejected electrons
3030
julia> λ = h / p # wavelength of ejected electrons
3131
3.029491247878056e-9 m
3232
33-
julia> as_units(λ, us"nm") # return answer in nanometers
33+
julia> as_u(λ, us"nm") # return answer in nanometers
3434
3.0294912478780556 nm
3535
```
3636
Since units are automatically propagated, we can verify the dimension of our answer and all intermediates.

docs/src/symbolic_units.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ To convert a quantity to its regular base SI units, use `expand_units`:
2020
expand_units
2121
```
2222

23-
To convert a quantity in regular base SI units to corresponding symbolic units, use `as_units`:
23+
To convert a quantity in regular base SI units to corresponding symbolic units, use `as_u`:
2424

2525
```@docs
26-
as_units
26+
as_u
2727
```

test/unittests.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -526,8 +526,8 @@ end
526526
@test us"Constants.h" != us"h"
527527
@test expand_units(us"Constants.h") == u"Constants.h"
528528

529-
@test as_units(5e-9u"m", us"nm") (5e-9u"m" |> as_units(us"nm")) 5us"nm"
530-
@test_throws DimensionError as_units(5e-9u"m", us"nm * J")
529+
@test as_u(5e-9u"m", us"nm") (5e-9u"m" |> as_u(us"nm")) 5us"nm"
530+
@test_throws DimensionError as_u(5e-9u"m", us"nm * J")
531531

532532
# Actually expands to:
533533
@test dimension(us"Constants.h")[:m] == 2

0 commit comments

Comments
 (0)