diff options
| author | Basil L. Contovounesios | 2022-08-13 21:59:39 +0300 |
|---|---|---|
| committer | Basil L. Contovounesios | 2022-08-13 21:59:39 +0300 |
| commit | 864847bf3c9f041256e32353b323ddafee86f6da (patch) | |
| tree | 415aed4316b7a9c7951a0fbc52a6a82323406d7c /doc | |
| parent | 0a9375938529c7603f19204cd166716f63e8a640 (diff) | |
| download | emacs-864847bf3c9f041256e32353b323ddafee86f6da.tar.gz emacs-864847bf3c9f041256e32353b323ddafee86f6da.zip | |
Document time-convert FORM argument as mandatory
This is a followup to commit b70369c557 of 2022-08-05
"time-convert): Deprecate calls without an explicit FORM arg".
* doc/lispref/os.texi (Time Conversion):
* src/timefns.c (Ftime_convert): Describe FORM argument as required
as per the advertised calling convention.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/os.texi | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index d591b219cd0..35828018417 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -1544,11 +1544,11 @@ as traditional Gregorian years do; for example, the year number | |||
| 1544 | @defun time-convert time form | 1544 | @defun time-convert time form |
| 1545 | This function converts a time value into a Lisp timestamp. | 1545 | This function converts a time value into a Lisp timestamp. |
| 1546 | 1546 | ||
| 1547 | The optional @var{form} argument specifies the timestamp form to be | 1547 | The @var{form} argument specifies the timestamp form to be returned. |
| 1548 | returned. If @var{form} is the symbol @code{integer}, this function | 1548 | If @var{form} is the symbol @code{integer}, this function returns an |
| 1549 | returns an integer count of seconds. If @var{form} is a positive | 1549 | integer count of seconds. If @var{form} is a positive integer, it |
| 1550 | integer, it specifies a clock frequency and this function returns an | 1550 | specifies a clock frequency and this function returns an integer-pair |
| 1551 | integer-pair timestamp @code{(@var{ticks} . @var{form})}. If @var{form} is | 1551 | timestamp @code{(@var{ticks} . @var{form})}. If @var{form} is |
| 1552 | @code{t}, this function treats it as a positive integer suitable for | 1552 | @code{t}, this function treats it as a positive integer suitable for |
| 1553 | representing the timestamp; for example, it is treated as 1000000000 | 1553 | representing the timestamp; for example, it is treated as 1000000000 |
| 1554 | if @var{time} is @code{nil} and the platform timestamp has nanosecond | 1554 | if @var{time} is @code{nil} and the platform timestamp has nanosecond |