Correct doctests to build docs (#124)

* Correct doctests to build docs

* Remove `doc` before triple quotes in docstrings

Author: lbenet

docs/src/multidim.md

@@ -38,7 +38,7 @@ julia> X = IntervalBox(1..1, 2..2)
 [1, 1] × [2, 2]
 
 julia> f(X...)  
-([3, 3],[-1, -1])
+([3, 3], [-1, -1])
 
 julia> IntervalBox(f(X...))
 [3, 3] × [-1, -1]

docs/src/usage.md

@@ -263,7 +263,7 @@ julia> @interval(pi)
 To check which mode is currently set, use
 ```jldoctest usage
 julia> precision(Interval)
-(Float64,256)
+(Float64, 256)
 ```
 The result is a tuple of the type (currently `Float64` or `BigFloat`) and the current `BigFloat` precision.
 
@@ -337,7 +337,7 @@ By default, the directed rounding used corresponds to using the `RoundDown` and
 
 ```jldoctest usage
 julia> setrounding(Interval, :slow)
-
+:slow
 ```
 
 An alternative rounding method is to perform calculations using the (standard) `RoundNearest` rounding mode, and then widen the result by one machine epsilon in each direction using `prevfloat` and `nextfloat`. This is achived by

src/display.jl

@@ -7,7 +7,7 @@ end
 const display_params = DisplayParameters(:standard, false, 6)
 
 
-doc"""
+"""
     setformat(;kw)
 
 `setformat` changes how intervals are displayed using keyword arguments.
@@ -49,7 +49,7 @@ function setformat(format = display_params.format;
     display_params.sigfigs = sigfigs
 end
 
-doc"""
+"""
     @format [style::Symbol] [decorations::Bool] [sigfigs::Integer]
 
 The `@format` macro provides a simple interface to control the output format

src/intervals/arithmetic.jl

@@ -311,7 +311,7 @@ end
 # mid, diam, radius
 
 # Compare pg. 64 of the IEEE 1788-2015 standard:
-doc"""
+"""
     mid(a::Interval, α=0.5)
 
 Find the midpoint (or, in general, an intermediate point) at a distance α along the interval `a`. The default is the true midpoint at α=0.5.
@@ -347,7 +347,7 @@ end
 
 mid(a::Interval{Rational{T}}) where T = (1//2) * (a.lo + a.hi)
 
-doc"""
+"""
     diam(a::Interval)
 
 Return the diameter (length) of the `Interval` `a`.
@@ -358,7 +358,7 @@ function diam(a::Interval{T}) where T<:Real
     @round_up(a.hi - a.lo) # cf page 64 of IEEE1788
 end
 
-doc"""
+"""
     radius(a::Interval)
 
 Return the radius of the `Interval` `a`, such that

src/intervals/macros.jl

@@ -1,6 +1,6 @@
 # This file is part of the IntervalArithmetic.jl package; MIT licensed
 
-doc"""The `@interval` macro is the main method to create an interval.
+"""The `@interval` macro is the main method to create an interval.
 It converts each expression into a narrow interval that is guaranteed to contain the true value passed by the user in the one or two expressions passed to it.
 When passed two expressions, it takes the hull of the resulting intervals
 to give a guaranteed containing interval.
@@ -20,19 +20,19 @@ macro interval(expr1, expr2...)
     make_interval(:(parameters.precision_type), expr1, expr2)
 end
 
-doc"The `@floatinterval` macro constructs an interval with `Float64` entries."
+"The `@floatinterval` macro constructs an interval with `Float64` entries."
 macro floatinterval(expr1, expr2...)
     make_interval(Float64, expr1, expr2)
 end
 
-doc"The `@biginterval` macro constructs an interval with `BigFloat` entries."
+"The `@biginterval` macro constructs an interval with `BigFloat` entries."
 macro biginterval(expr1, expr2...)
     make_interval(BigFloat, expr1, expr2)
 end
 
 
 
-doc"""`transform` transforms a string by applying the function `f` and type
+"""`transform` transforms a string by applying the function `f` and type
 `T` to each argument, i.e. `:(x+y)` is transformed to `:(f(T, x) + f(T, y))`
 """
 transform(x::Symbol, f, T) = :($f($T, $(esc(x))))   # use if x is not an expression
@@ -74,7 +74,7 @@ end
 
 
 # Called by interval and floatinterval macros
-doc"""`make_interval` does the hard work of taking expressions
+"""`make_interval` does the hard work of taking expressions
 and making each literal (0.1, 1, etc.) into a corresponding interval construction,
 by calling `transform`."""
 

src/intervals/rounding.jl

@@ -26,7 +26,7 @@ In Julia v0.6 and later (but *not* in Julia v0.5), this automatically redefines
 =#
 
 
-doc"""Interval rounding trait type"""
+"""Interval rounding trait type"""
 struct IntervalRounding{T} end
 
 # Functions that are the same for all rounding types:
@@ -241,7 +241,7 @@ function _setrounding(::Type{Interval}, rounding_type::Symbol)
     current_rounding_type[] = rounding_type
 end
 
-doc"""
+"""
     setrounding(Interval, rounding_type::Symbol)
 
 Set the rounding type used for all interval calculations on Julia v0.6 and above.

src/intervals/set_operations.jl

@@ -69,7 +69,7 @@ Returns the "interval hull" of the intervals `a` and `b`, considered as
 all of `a` and `b`.
 """
 hull(a::Interval, b::Interval) = Interval(min(a.lo, b.lo), max(a.hi, b.hi))
-# 
+#
 # hull{T,S}(a::Interval{T}, b::Interval{S}) = hull(promote(a, b)...)
 
 """
@@ -84,7 +84,7 @@ union(a::Interval, b::Interval) = hull(a, b)
 # union(a::Interval, b::Interval) = union(promote(a, b)...)
 
 
-doc"""
+"""
     setdiff(x::Interval, y::Interval)
 
 Calculate the set difference `x \ y`, i.e. the set of values

src/intervals/special.jl

@@ -3,7 +3,7 @@
 ## Definitions of special intervals and associated functions
 
 ## Empty interval:
-doc"""`emptyinterval`s are represented as the interval [∞, -∞]; note
+"""`emptyinterval`s are represented as the interval [∞, -∞]; note
 that this interval is an exception to the fact that the lower bound is
 larger than the upper one."""
 emptyinterval(::Type{T}) where T<:Real = Interval{T}(Inf, -Inf)
@@ -16,7 +16,7 @@ isempty(x::Interval) = x.lo == Inf && x.hi == -Inf
 const ∞ = Inf
 
 ## Entire interval:
-doc"""`entireinterval`s represent the whole Real line: [-∞, ∞]."""
+"""`entireinterval`s represent the whole Real line: [-∞, ∞]."""
 entireinterval(::Type{T}) where T<:Real = Interval{T}(-Inf, Inf)
 entireinterval(x::Interval{T}) where T<:Real = entireinterval(T)
 entireinterval() = entireinterval(precision(Interval)[1])
@@ -26,7 +26,7 @@ isunbounded(x::Interval) = x.lo == -Inf || x.hi == Inf
 
 
 # NaI: not-an-interval
-doc"""`NaI` not-an-interval: [NaN, NaN]."""
+"""`NaI` not-an-interval: [NaN, NaN]."""
 nai(::Type{T}) where T<:Real = Interval{T}(convert(T, NaN), convert(T, NaN))
 nai(x::Interval{T}) where T<:Real = nai(T)
 nai() = nai(precision(Interval)[1])
@@ -36,7 +36,7 @@ isnai(x::Interval) = isnan(x.lo) || isnan(x.hi)
 isfinite(x::Interval) = isfinite(x.lo) && isfinite(x.hi)
 isnan(x::Interval) = isnai(x)
 
-doc"""
+"""
     isthin(x)
 
 Checks if `x` is the set consisting of a single exactly
@@ -46,7 +46,7 @@ the standard.
 """
 isthin(x::Interval) = x.lo == x.hi
 
-doc"""
+"""
     iscommon(x)
 
 Checks if `x` is a **common interval**, i.e. a non-empty,
@@ -77,7 +77,7 @@ isatomic(x::Interval) = isempty(x) || (x.hi == x.lo) || (x.hi == nextfloat(x.lo)
 
 Base.iszero(x::Interval) = iszero(x.lo) && iszero(x.hi)
 
-# doc"""
+# """
 #     widen(x)
 #
 # Widens the lowest and highest bounds of `x` to the previous

src/intervals/trigonometric.jl

@@ -22,7 +22,7 @@ half_range_atan2(::Type{T}) where {T} = (temp = half_pi(T); Interval(-(temp.hi),
 pos_range_atan2(::Type{T}) where {T<:Real} = Interval(zero(T), pi_interval(T).hi)
 
 
-doc"""Finds the quadrant(s) corresponding to a given floating-point
+"""Finds the quadrant(s) corresponding to a given floating-point
 number. The quadrants are labelled as 0 for x ∈ [0, π/2], etc.
 For numbers very near a boundary of the quadrant, a tuple of two quadrants
 is returned. The minimum or maximum must then be chosen appropriately.

src/multidim/intervalbox.jl

@@ -1,7 +1,7 @@
 # This file is part of the IntervalArithmetic.jl package; MIT licensed
 
-doc"""An `IntervalBox` is an $N$-dimensional rectangular box, given
-by a Cartesian product of $N$ `Interval`s.
+"""An `IntervalBox` is an `N`-dimensional rectangular box, given
+by a Cartesian product of `N` `Interval`s.
 """
 struct IntervalBox{N,T} <: StaticVector{N, Interval{T}}
     data::NTuple{N,Interval{T}}