Skip to content

Commit

Permalink
Merge pull request #138 from invenia/mz/docs
Browse files Browse the repository at this point in the history
add inclusivity default info to the docstrings for HourEnding and HourBeginning
  • Loading branch information
mzgubic committed Aug 19, 2020
2 parents d7a27c3 + 282676f commit bfa3ea8
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/anchoredinterval.jl
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@ AnchoredInterval{P}(anchor::T) where {P,T} = AnchoredInterval{P,T}(anchor)
A type alias for `AnchoredInterval{Hour(-1), T}` which is used to denote a 1-hour period of
time which ends at a time instant (of type `T`).
When constructing an instance of `HourEnding{T}` the resulting interval will right-closed
(of type `HourEnding{T,Open,Closed}`).
"""
const HourEnding{T,L,R} = AnchoredInterval{Hour(-1), T, L, R} where {T, L <: Bounded, R <: Bounded}
HourEnding(anchor::T) where T = HourEnding{T}(anchor)
Expand All @@ -130,6 +133,9 @@ HourEnding(anchor::T) where T = HourEnding{T}(anchor)
A type alias for `AnchoredInterval{Hour(1), T}` which is used to denote a 1-hour period of
time which begins at a time instant (of type `T`).
When constructing an instance of `HourBeginning{T}` the resulting interval will left-closed
(of type `HourBeginning{T,Closed,Open}`).
"""
const HourBeginning{T,L,R} = AnchoredInterval{Hour(1), T, L, R} where {T, L <: Bounded, R <: Bounded}
HourBeginning(anchor::T) where T = HourBeginning{T}(anchor)
Expand Down

0 comments on commit bfa3ea8

Please sign in to comment.