jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

times.nim: Fix docs for duration conversion procs [ci skip] (#10770)

Browse source
This commit is contained in:
ee7 2019-03-02 17:25:14 +00:00 • committed by Miran
commit d6882691ad
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lib/pure/times.nim
View file

@ -515,14 +515,14 @@ proc inHours*(dur: Duration): int64 =
## Convert the duration to the number of whole hours. ## Convert the duration to the number of whole hours.
runnableExamples: runnableExamples:
let dur = initDuration(minutes = 60, days = 2) let dur = initDuration(minutes = 60, days = 2)
doAssert dur.hours == 49 doAssert dur.inHours == 49
dur.convert(Hours) dur.convert(Hours)
proc inMinutes*(dur: Duration): int64 = proc inMinutes*(dur: Duration): int64 =
## Convert the duration to the number of whole minutes. ## Convert the duration to the number of whole minutes.
runnableExamples: runnableExamples:
let dur = initDuration(hours = 2, seconds = 10) let dur = initDuration(hours = 2, seconds = 10)
doAssert dur.minutes == 120 doAssert dur.inMinutes == 120
dur.convert(Minutes) dur.convert(Minutes)
proc inSeconds*(dur: Duration): int64 = proc inSeconds*(dur: Duration): int64 =
@ -2612,10 +2612,10 @@ proc minutes*(dur: Duration): int64
proc seconds*(dur: Duration): int64 proc seconds*(dur: Duration): int64
{.inline, deprecated: "Use `inSeconds` instead".} = {.inline, deprecated: "Use `inSeconds` instead".} =
## Number of whole minutes represented by the duration. ## Number of whole seconds represented by the duration.
## ##
## **Deprecated since version v0.20.0**: Use the `inMinutes proc ## **Deprecated since version v0.20.0**: Use the `inSeconds proc
## <#inMinutes,Duration>`_ instead. ## <#inSeconds,Duration>`_ instead.
runnableExamples: runnableExamples:
let dur = initDuration(minutes = 10, seconds = 30) let dur = initDuration(minutes = 10, seconds = 30)
doAssert dur.seconds == 630 doAssert dur.seconds == 630