Skip to content

Commit

Permalink
Update Time adjuster function documentation to be more explicit about…
Browse files Browse the repository at this point in the history
… default step period
  • Loading branch information
quinnj committed Jan 26, 2017
1 parent 94aa901 commit 2dd9ff8
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion base/dates/adjusters.jl
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,10 @@ function DateTime(func::Function, y, m, d, h, mi, s; step::Period=Millisecond(1)
end

"""
Time(f::Function, h[, mi, s, ms, us]; step=Second(1), limit=10000) -> Time
Time(func::Function, h, mi=0; step::Period=Second(1), negate::Bool=false, limit::Int=10000)
Time(func::Function, h, mi, s; step::Period=Millisecond(1), negate::Bool=false, limit::Int=10000)
Time(func::Function, h, mi, s, ms; step::Period=Microsecond(1), negate::Bool=false, limit::Int=10000)
Time(func::Function, h, mi, s, ms, us; step::Period=Nanosecond(1), negate::Bool=false, limit::Int=10000)
Create a `Time` through the adjuster API. The starting point will be constructed from the
provided `h, mi, s, ms, us` arguments, and will be adjusted until `f::Function` returns `true`.
Expand Down

0 comments on commit 2dd9ff8

Please sign in to comment.