From a038c62befcf5150f7e4cffe176e49c8ce85d467 Mon Sep 17 00:00:00 2001
From: Federico Ceratto <federico.ceratto@suse.com>
Date: Sat, 29 Jul 2017 11:42:03 +0100
Subject: Add TimeInterval reversing docstring

---
 lib/pure/times.nim | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'lib/pure')

diff --git a/lib/pure/times.nim b/lib/pure/times.nim
index 1bda94d14..c2809acf7 100644
--- a/lib/pure/times.nim
+++ b/lib/pure/times.nim
@@ -301,6 +301,11 @@ proc `+`*(ti1, ti2: TimeInterval): TimeInterval =
   result.years = carryO + ti1.years + ti2.years
 
 proc `-`*(ti: TimeInterval): TimeInterval =
+  ## Reverses a time interval
+  ## .. code-block:: nim
+  ##
+  ##     let day = -initInterval(hours=24)
+  ##     echo day  # -> (milliseconds: 0, seconds: 0, minutes: 0, hours: 0, days: -1, months: 0, years: 0)
   result = TimeInterval(
     milliseconds: -ti.milliseconds,
     seconds: -ti.seconds,
-- 
cgit 1.4.1-2-gfad0