better output

cormullion · cormullion · commit 40844d891c78 · 2017-12-12T09:37:54.000Z
diff --git a/README.md b/README.md
@@ -11,16 +11,29 @@ time Julia code running in global scope!)
 
 This code used to live in Julia Base in the `tic()`, `toc()`, and `toq()` functions (in base/util.jl). They were deprecated in GitHub issue [17046](https://github.com/JuliaLang/julia/issues/17046).
 
+The [TimerOutputs.jl](https://github.com/KristofferC/TimerOutputs.jl) package provides tools for timing different sections of a program.
+
 ## Example
 
 ```julia
 julia-0.6> using TickTock
 
 julia-0.6> tick()
-0x0000146b7dcc5c23
+INFO: Started timer at 2017-12-12T09:33:00.363.
 
 julia-0.6> tock()
-2 seconds
+INFO: Time taken: 149.427977832
+INFO:             2 minutes, 29 seconds, 427 milliseconds
+```
+
+To return the elapsed time in seconds, use `tok()`:
+
+```julia
+julia-0.6> tick()
+INFO: Started timer at 2017-12-12T09:17:45.504.
+
+julia-0.6> tok()
+287.841546621
 ```
 
 [![Build Status](https://travis-ci.org/cormullion/TickTock.jl.svg?branch=master)](https://travis-ci.org/cormullion/TickTock.jl)
diff --git a/appveyor.yml b/appveyor.yml
@@ -7,10 +7,10 @@ environment:
 
 ## uncomment the following lines to allow failures on nightly julia
 ## (tests will run but not make your overall status red)
-#matrix:
-#  allow_failures:
-#  - JULIA_URL: "https://julialangnightlies-s3.julialang.org/bin/winnt/x86/julia-latest-win32.exe"
-#  - JULIA_URL: "https://julialangnightlies-s3.julialang.org/bin/winnt/x64/julia-latest-win64.exe"
+matrix:
+  allow_failures:
+  - JULIA_URL: "https://julialangnightlies-s3.julialang.org/bin/winnt/x86/julia-latest-win32.exe"
+  - JULIA_URL: "https://julialangnightlies-s3.julialang.org/bin/winnt/x64/julia-latest-win64.exe"
 
 branches:
   only:
diff --git a/src/TickTock.jl b/src/TickTock.jl
@@ -23,7 +23,7 @@ Start counting.
 function tick()
     t0 = time_ns()
     task_local_storage(:TIMERS, (t0, get(task_local_storage(), :TIMERS, ())))
-    return t0
+    info("Started timer at $(now()).")
 end
 
 """
@@ -39,19 +39,20 @@ function tok()
     end
     t0 = timers[1]::UInt64
     task_local_storage(:TIMERS, timers[2])
-    (t1-t0)/1e9 # seconds
+    return (t1-t0)/1e9 # seconds
 end
 
 """
     tock()
 
-Print the elapsed time, in suitably canonical form, since the previous `tick()`,
+Print the elapsed time, in canonical form, since the previous `tick()`,
 and then stop counting.
 """
 function tock()
     t = tok()
-    canondc = Dates.canonicalize(Dates.CompoundPeriod(Dates.Second(floor(t))))
-    println(canondc)
+    canondc = Dates.canonicalize(Dates.CompoundPeriod(Dates.Second(floor(t)), Dates.Millisecond(floor((t-floor(t)) * 1000))))
+    info("Time taken: $t")
+    info("            $canondc")
 end
 
 end # module
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1,8 +1,6 @@
 using TickTock
 using Base.Test
 
-# write your own tests here
 tick()
 sleep(1)
 @test tok() > 1.0
- 
