decoded-time-add doc string addition

* lisp/calendar/time-date.el (decoded-time-add): Add a usage example.
This commit is contained in:
Lars Ingebrigtsen 2021-10-12 21:55:26 +02:00
parent 83195c57e6
commit 85edcf7af5

View file

@ -406,7 +406,11 @@ entries only for the values that should be altered.
For instance, if you want to \"add two months\" to TIME, then
leave all other fields but the month field in DELTA nil, and make
the month field 2. The values in DELTA can be negative.
the month field 2. For instance:
(decoded-time-add (decode-time) (make-decoded-time :month 2))
The values in DELTA can be negative.
If applying a month/year delta leaves the time spec invalid, it
is decreased to be valid (\"add one month\" to January 31st 2019