; Improve documentation of 'world-clock'
authorEli Zaretskii <eliz@gnu.org>
Wed, 10 Apr 2024 13:52:21 +0000 (16:52 +0300)
committerEli Zaretskii <eliz@gnu.org>
Wed, 10 Apr 2024 13:52:21 +0000 (16:52 +0300)
* lisp/time.el (zoneinfo-style-world-list)
(legacy-style-world-list): Doc fixes.

lisp/time.el

index 6d95ae326c6d416c1c8c0031f71624e2df681307..29c7f53ac1f14cbd68200b02049e04136d079841 100644 (file)
@@ -452,7 +452,11 @@ Each element has the form (TIMEZONE LABEL).
 TIMEZONE should be a string of the form AREA/LOCATION, where AREA is
 the name of a region -- a continent or ocean, and LOCATION is the name
 of a specific location, e.g., a city, within that region.
-LABEL is a string to display as the label of that TIMEZONE's time."
+LABEL is a string to display as the label of that TIMEZONE's time.
+
+This option has effect only on systems that support Posix-style
+zoneinfo files specified as CONTINENT/CITY.  In particular,
+MS-Windows doesn't support that; use `legacy-style-world-list' instead."
   :type '(repeat (list string string))
   :version "23.1")
 
@@ -471,7 +475,10 @@ TIMEZONE should be a string of the form:
 
 See the documentation of the TZ environment variable on your system,
 for more details about the format of TIMEZONE.
-LABEL is a string to display as the label of that TIMEZONE's time."
+LABEL is a string to display as the label of that TIMEZONE's time
+
+This is the only option that has effect on MS-Windows, where you also
+cannot specify the [offset][,date[/time],date[/time]] part."
   :type '(repeat (list string string))
   :version "23.1")