Default decoded-time dst slot to -1

* lisp/simple.el (decoded-time): Default dst slot to -1.
Improve related doc strings.
This commit is contained in:
Paul Eggert 2022-06-13 14:25:58 -07:00
parent 24b2cc177a
commit 5678829a62
2 changed files with 12 additions and 7 deletions

View file

@ -557,7 +557,8 @@ changes in daylight saving time are not taken into account."
(list second minute hour day month year nil dst zone))
(defun decoded-time-set-defaults (time &optional default-zone)
"Set any nil values in `decoded-time' TIME to default values.
"Set most nil values in `decoded-time' TIME to default values.
This can set TIME's year, month, day, hour, minute and second.
The default value is based on January 1st, 1970 at midnight.
This year is used to guarantee portability; see Info
node `(elisp) Time of Day'.

View file

@ -10511,10 +10511,10 @@ This is an integer between 1 and 12 (inclusive). January is 1.")
(year nil :documentation "This is a four digit integer.")
(weekday nil :documentation "\
This is a number between 0 and 6, and 0 is Sunday.")
(dst nil :documentation "\
(dst -1 :documentation "\
This is t if daylight saving time is in effect, nil if it is not
in effect, and -1 if daylight saving information is not
available.")
in effect, and -1 if daylight saving information is not available.
Also see `decoded-time-dst'.")
(zone nil :documentation "\
This is an integer indicating the UTC offset in seconds, i.e.,
the number of seconds east of Greenwich.")
@ -10524,9 +10524,13 @@ the number of seconds east of Greenwich.")
;; It should return -1 indicating unknown DST, but currently returns
;; nil indicating standard time.
(put 'decoded-time-dst 'function-documentation
(append (get 'decoded-time-dst 'function-documentation)
"As a special case, `decoded-time-dst' returns an unspecified
value when given a list too short to have a dst element."))
"Access slot \"dst\" of `decoded-time' struct CL-X.
This is t if daylight saving time is in effect, nil if it is not
in effect, and -1 if daylight saving information is not available.
As a special case, return an unspecified value when given a list
too short to have a dst element.
(fn CL-X)")
(defun get-scratch-buffer-create ()
"Return the *scratch* buffer, creating a new one if needed."