Update docs to include bound-open

invenia · Sep 23, 2020 · 3b31ff4 · 3b31ff4
1 parent e32992e
commit 3b31ff4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/src/docstrings.jl b/src/docstrings.jl
@@ -109,9 +109,10 @@ isbounded(::AbstractInterval)
 """
     minimum(interval::AbstractInterval{T}; [increment]) -> T
 
-The minimum value in the interval contained within the interval.
+The minimum value in the interval contained within the `interval`.
 
 If left-closed, returns `first(interval)`.
+If left-open, returns `first(interval) + eps(first(interval))`
 If left-unbounded, returns minimum value possible for type `T`.
 
 A `BoundsError` is thrown for empty intervals or when the increment results in a minimum value
@@ -122,9 +123,10 @@ minimum(::AbstractInterval; increment)
 """
     maximum(interval::AbstractInterval{T}; increment::Any) -> T
 
-The maximum value in the interval contained within the interval.
+The maximum value in the interval contained within the `interval`.
 
 If right-closed, returns `last(interval)`.
+If right-open, returns `first(interval) + eps(first(interval))`
 If right-unbounded, returns maximum value possible for type `T`.
 
 A `BoundsError` is thrown for empty intervals or when the increment results in a maximum value

diff --git a/test/anchoredinterval.jl b/test/anchoredinterval.jl
@@ -177,7 +177,6 @@ using Intervals: Bounded, Ending, Beginning, canonicalize, isunbounded
 
         @test first(interval) == Date(2016, 8, 11)
         @test last(interval) == Date(2016, 8, 12)
-        # throws domain error
         @test_throws BoundsError minimum(interval, increment=Day(1))
         @test_throws BoundsError maximum(interval, increment=Day(1))
         @test bounds_types(interval) == (Open, Open)