From 1712109cdf51f58a155f8804cb54236c408071c8 Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Mon, 16 Nov 2009 16:44:17 -0600 Subject: [PATCH] fix help lint for calendar --- basis/calendar/calendar-docs.factor | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/basis/calendar/calendar-docs.factor b/basis/calendar/calendar-docs.factor index b774e79b8b..616c4d2c2c 100644 --- a/basis/calendar/calendar-docs.factor +++ b/basis/calendar/calendar-docs.factor @@ -355,7 +355,7 @@ HELP: before HELP: { $values { "timestamp" timestamp } } -{ $description "Outputs a zero timestamp that consists of zeros for every slot. Used to see if timestamps are valid." } ; +{ $description "Returns a zero timestamp that consists of zeros for every slot. Used to see if timestamps are valid." } ; HELP: valid-timestamp? { $values { "timestamp" timestamp } { "?" "a boolean" } } @@ -363,7 +363,7 @@ HELP: valid-timestamp? HELP: unix-1970 { $values { "timestamp" timestamp } } -{ $description "Outputs the beginning of UNIX time, or midnight, January 1, 1970." } ; +{ $description "Returns the beginning of UNIX time, or midnight, January 1, 1970." } ; HELP: micros>timestamp { $values { "x" number } { "timestamp" timestamp } } @@ -377,13 +377,13 @@ HELP: micros>timestamp HELP: gmt { $values { "timestamp" timestamp } } -{ $description "Outputs the time right now, but in the GMT timezone." } ; +{ $description "Returns the time right now, but in the GMT timezone." } ; { gmt now } related-words HELP: now { $values { "timestamp" timestamp } } -{ $description "Outputs the time right now in your computer's timezone." } +{ $description "Returns the time right now in your computer's timezone." } { $examples { $unchecked-example "USING: calendar prettyprint ;" "now ." @@ -490,23 +490,23 @@ HELP: saturday HELP: midnight { $values { "timestamp" timestamp } { "new-timestamp" timestamp } } -{ $description "Returns a timestamp that represents today at midnight, or the beginning of the day." } ; +{ $description "Returns a new timestamp that represents today at midnight, or the beginning of the day." } ; HELP: noon { $values { "timestamp" timestamp } { "new-timestamp" timestamp } } -{ $description "Returns a timestamp that represents today at noon, or the middle of the day." } ; +{ $description "Returns a new timestamp that represents today at noon, or the middle of the day." } ; HELP: beginning-of-month { $values { "timestamp" timestamp } { "new-timestamp" timestamp } } -{ $description "Outputs a timestamp with the day set to one." } ; +{ $description "Returns a new timestamp with the day set to one." } ; HELP: beginning-of-week { $values { "timestamp" timestamp } { "new-timestamp" timestamp } } -{ $description "Outputs a timestamp where the day of the week is Sunday." } ; +{ $description "Returns a new timestamp where the day of the week is Sunday." } ; HELP: beginning-of-year -{ $values { "timestamp" timestamp } { "new-timestamp" timestamp } } -{ $description "Outputs a timestamp with the month and day set to one, or January 1 of the input timestamp." } ; +{ $values { "object" object } { "new-timestamp" timestamp } } +{ $description "Returns a new timestamp with the month and day set to one, or January 1 of the input timestamp, given a year or a timestamp." } ; HELP: time-since-midnight { $values { "timestamp" timestamp } { "duration" duration } }