Skip to content

Commit

Permalink
documenter
Browse files Browse the repository at this point in the history
  • Loading branch information
cmichelenstrofer committed Nov 28, 2023
1 parent 75b911b commit f737fc1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions docs/src/guide/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The units in this package are appended the superscript `ᵃ` to differentiate th
The [`@ua_str`](@ref) provides an easier way to access these units without having to type the superscript ``.
For example, both of these are equivalent:

```jldoctest
```jldoctest; filter = r"(\\d*).(\\d{1,10})\\d+" => s"\\1.\\2"
julia> using Unitful
julia> using DimensionfulAngles
Expand All @@ -32,7 +32,7 @@ julia> 1.3ua"rad"

The default `u` string can still be more convenient when defining quantities with mixed units, such as

```jldoctest
```jldoctest; filter = r"(\\d*).(\\d{1,10})\\d+" => s"\\1.\\2"
julia> using Unitful
julia> using DimensionfulAngles
Expand All @@ -44,7 +44,7 @@ julia> 2.1u"radᵃ/s"
Alternatively it might be convenient to import the units you are using directly, renaming units from *DimensionfulAngles* to remove the superscript ``.
For example:

```jldoctest
```jldoctest; filter = r"(\\d*).(\\d{1,10})\\d+" => s"\\1.\\2"
julia> using Unitful
julia> using Unitful: m, s, kg
Expand All @@ -71,7 +71,7 @@ One of the main advantage of defining an angle dimension is to be able to dispat
This behavior and useful aliases are completely inherited from *Unitful.jl*.
The most basic usage uses the automatically defined alias [`DimensionfulAngles.Angle`](@ref):

```jldoctest
```jldoctest; filter = r"(\\d*).(\\d{1,10})\\d+" => s"\\1.\\2"
julia> using Unitful
julia> using DimensionfulAngles
Expand All @@ -98,7 +98,7 @@ julia> what_am_i(angle)
Finally, we can convert quantities to or from `Unitful` using an extension of `uconvert`
with first argument `:Unitful` or `:DimensionfulAngles`, as:

```julia
```jldoctest; filter = r"(\\d*).(\\d{1,10})\\d+" => s"\\1.\\2"
julia> ω = 3.2u"radᵃ/s"
3.2 rad s⁻¹
Expand Down
2 changes: 1 addition & 1 deletion docs/src/proposed.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ This is in agreement with the proposals discussed above.
In contrast to these proposals, one of the goals of this package is to ***not*** require the use of the constant `θ₀` for normalizing inputs to common functions.
To this end, the extensions to functions in `Base` ensure that function calls like

```jldoctest; setup = :(using DimensionfulAngles)
```jldoctest; setup = :(using DimensionfulAngles), filter = r"(\\d*).(\\d{1,10})\\d+" => s"\\1.\\2"
julia> cos(45ua"°")
0.7071067811865476
```
Expand Down

0 comments on commit f737fc1

Please sign in to comment.