calendar: change >gmt, >local-time to clone.

[factor.git] / basis / calendar / calendar-docs.factor

diff --git a/basis/calendar/calendar-docs.factor b/basis/calendar/calendar-docs.factor
index 22b565cacd322a9b3395690ddda784ff92d1f459..e2fa95d4e76e3a0d4cd9d3e0b0d0caa106835a81 100644 (file)
--- a/basis/calendar/calendar-docs.factor
+++ b/basis/calendar/calendar-docs.factor
@@ -271,19 +271,19 @@ HELP: convert-timezone
     }
 } ;
 
-HELP: >local
-{ $values { "timestamp" timestamp } }
-{ $description "Converts the " { $snippet "timestamp" } " to the timezone of your computer." }
+HELP: >local-time
+{ $values { "timestamp" timestamp } { "timestamp'" timestamp } }
+{ $description "Converts the " { $snippet "timestamp" } " to the timezone of your computer, returning a new " { $link timestamp } " instance." }
 { $examples
     { $example "USING: accessors calendar kernel prettyprint ;"
-               "now now-gmt >local [ gmt-offset>> ] same? ."
+               "now now-gmt >local-time [ gmt-offset>> ] same? ."
                "t"
     }
 } ;
 
 HELP: >gmt
-{ $values { "timestamp" timestamp } }
-{ $description "Converts the " { $snippet "timestamp" } " to the GMT timezone." }
+{ $values { "timestamp" timestamp } { "timestamp'" timestamp } }
+{ $description "Converts the " { $snippet "timestamp" } " to the GMT timezone, returning a new " { $link timestamp } " instance." }
 { $examples
     { $example "USING: accessors calendar kernel prettyprint ;"
                "now >gmt gmt-offset>> hour>> ."
@@ -291,17 +291,17 @@ HELP: >gmt
     }
 } ;
 
-HELP: local
+HELP: local-time
 { $values { "timestamp" timestamp } }
 { $description "Set the time zone to the computer's local timezone." }
-{ $notes "The time is not converted, if you want that then call " { $link >local } "." } ;
+{ $notes "The time is not converted, if you want that then call " { $link >local-time } "." } ;
 
 HELP: gmt
 { $values { "timestamp" timestamp } }
 { $description "Set the time zone to GMT." }
 { $notes "The time is not converted, if you want that then call " { $link >gmt } "." } ;
 
-{ local >local gmt >gmt convert-timezone } related-words
+{ local-time >local-time convert-local-time gmt >gmt convert-gmt utc >utc convert-utc convert-timezone } related-words
 
 HELP: duration*
 { $values { "obj1" object } { "obj2" object } { "obj3" object } }
@@ -511,8 +511,9 @@ ARTICLE: "calendar" "Calendar"
 }
 "Time zones:"
 { $subsections
-    >local
+    >local-time
     >gmt
+    >utc
     convert-timezone
 }
 "Timestamps relative to each other:"