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

Some documentation fixes in times module.

Browse source
This commit is contained in:
Dominik Picheta 2016-04-06 10:45:39 +01:00
commit 9b6fda144a
1 changed files with 15 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

21
lib/pure/times.nim
View file

@ -187,7 +187,9 @@ proc timeInfoToTime*(timeInfo: TimeInfo): Time {.tags: [], benign, deprecated.}
## calendar time representation. The function ignores the specified ## calendar time representation. The function ignores the specified
## contents of the structure members `weekday` and `yearday` and recomputes ## contents of the structure members `weekday` and `yearday` and recomputes
## them from the other information in the broken-down time structure. ## them from the other information in the broken-down time structure.
## **Warning:** This procedure is deprecated. Use toTime instead. ##
## **Warning:** This procedure is deprecated since version 0.14.0.
## Use ``toTime`` instead.
proc toTime*(timeInfo: TimeInfo): Time {.tags: [], benign.} proc toTime*(timeInfo: TimeInfo): Time {.tags: [], benign.}
## converts a broken-down time structure to ## converts a broken-down time structure to
@ -1225,7 +1227,7 @@ proc parse*(value, layout: string): TimeInfo =
proc countLeapYears*(yearSpan: int): int = proc countLeapYears*(yearSpan: int): int =
## Returns the number of leap years spanned by a given number of years. ## Returns the number of leap years spanned by a given number of years.
## ##
## Note: for leap years, start date is assumed to be 1 AD. ## **Note:** For leap years, start date is assumed to be 1 AD.
## counts the number of leap years up to January 1st of a given year. ## counts the number of leap years up to January 1st of a given year.
## Keep in mind that if specified year is a leap year, the leap day ## Keep in mind that if specified year is a leap year, the leap day
## has not happened before January 1st of that year. ## has not happened before January 1st of that year.
@ -1260,13 +1262,14 @@ proc getDayOfWeek*(day, month, year: int): WeekDay =
y = year - a y = year - a
m = month + (12*a) - 2 m = month + (12*a) - 2
d = (day + y + (y div 4) - (y div 100) + (y div 400) + (31*m) div 12) mod 7 d = (day + y + (y div 4) - (y div 100) + (y div 400) + (31*m) div 12) mod 7
# The value of d is 0 for a Sunday, 1 for a Monday, 2 for a Tuesday, etc. so we must correct # The value of d is 0 for a Sunday, 1 for a Monday, 2 for a Tuesday, etc.
# for the WeekDay type. # so we must correct for the WeekDay type.
if d == 0: return dSun if d == 0: return dSun
result = (d-1).WeekDay result = (d-1).WeekDay
proc getDayOfWeekJulian*(day, month, year: int): WeekDay = proc getDayOfWeekJulian*(day, month, year: int): WeekDay =
## Returns the day of the week enum from day, month and year, according to the Julian calendar. ## Returns the day of the week enum from day, month and year,
## according to the Julian calendar.
# Day & month start from one. # Day & month start from one.
let let
a = (14 - month) div 12 a = (14 - month) div 12
@ -1277,7 +1280,9 @@ proc getDayOfWeekJulian*(day, month, year: int): WeekDay =
proc timeToTimeInfo*(t: Time): TimeInfo {.deprecated.} = proc timeToTimeInfo*(t: Time): TimeInfo {.deprecated.} =
## Converts a Time to TimeInfo. ## Converts a Time to TimeInfo.
## **Warning:** This procedure is deprecated. Use getLocalTime or getGMTime instead. ##
## **Warning:** This procedure is deprecated since version 0.14.0.
## Use ``getLocalTime`` or ``getGMTime`` instead.
let let
secs = t.toSeconds().int secs = t.toSeconds().int
daysSinceEpoch = secs div secondsInDay daysSinceEpoch = secs div secondsInDay
@ -1310,7 +1315,9 @@ proc timeToTimeInfo*(t: Time): TimeInfo {.deprecated.} =
proc timeToTimeInterval*(t: Time): TimeInterval {.deprecated.} = proc timeToTimeInterval*(t: Time): TimeInterval {.deprecated.} =
## Converts a Time to a TimeInterval. ## Converts a Time to a TimeInterval.
## **Warning:** This procedure is deprecated. Use toTimeInterval instead. ##
## **Warning:** This procedure is deprecated since version 0.14.0.
## Use ``toTimeInterval`` instead.
# Milliseconds not available from Time # Milliseconds not available from Time
var tInfo = t.getLocalTime() var tInfo = t.getLocalTime()
initInterval(0, tInfo.second, tInfo.minute, tInfo.hour, tInfo.weekday.ord, tInfo.month.ord, tInfo.year) initInterval(0, tInfo.second, tInfo.minute, tInfo.hour, tInfo.weekday.ord, tInfo.month.ord, tInfo.year)