Skip to content

Commit 8752dcb

Browse files
committed
Update docs
1 parent 987a5f7 commit 8752dcb

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

docs/src/manual/construction.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -145,13 +145,12 @@ interval(1) # considered "guaranteed" as the user explicitly constructed the int
145145

146146
In contrast, a [`BareInterval`](@ref) can only be constructed via [`bareinterval`](@ref), it is not a subtype of `Real`, and there are no allowed conversion with `Number`. Thus, this interval type is always guaranteed.
147147

148-
149148
!!! danger
150-
A user interested in validated numerics should **always** have a resulting interval for which [`isguaranteed`](@ref) is `true`.
149+
A user interested in validated numerics should **always** track down the source of an "NG" label.
151150

152151

153152

154-
## More constructors
153+
### More constructors
155154

156155
The submodule `IntervalArithmetic.Symbols` exports the infix operator `..` and `±` as an alias for `interval`; this submodule must be explicitly imported.
157156

docs/src/manual/usage.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,10 @@ One can refer to the following:
123123
- `setdiff`: cannot be used with intervals. See instead [`interiordiff`](@ref).
124124

125125

126+
126127
## Piecewise functions
127128

128-
Since intervals don't play well with `if .. else .. end` statement,
129+
Since intervals don't play well with `if ... else ... end` statement,
129130
we provide a utility to define function by pieces:
130131

131132
```@repl usage
@@ -141,6 +142,7 @@ The resulting function work with both standard numbers and intervals,
141142
and deal properly with the decorations of intervals.
142143

143144

145+
144146
## Custom interval bounds type
145147

146148
A `BareInterval{T}` or `Interval{T}` have the restriction `T <: Union{Rational,AbstractFloat}` which is the parametric type for the bounds of the interval. Supposing one wishes to use their own numeric type `MyNumType <: Union{Rational,AbstractFloat}`, they must provide their own arithmetic operations (with correct rounding!).

0 commit comments

Comments
 (0)