Skip to content

Commit

Permalink
Update doc of absolute-time
Browse files Browse the repository at this point in the history
  • Loading branch information
shirok committed Nov 27, 2023
1 parent f96864b commit a9397c3
Showing 1 changed file with 40 additions and 25 deletions.
65 changes: 40 additions & 25 deletions doc/corelib.texi
Original file line number Diff line number Diff line change
Expand Up @@ -32073,32 +32073,13 @@ Returns @code{#t} if @var{obj} is a time object.
@c COMMON
@end defun

@defun seconds+ time x
[SRFI-226]
@c EN
Returns a time object that is @var{x} seconds after the given @var{time}.
The type of returned time object is the same as @var{time}.
The argument @var{x} must be a finite real number. If it is negative,
returnd time is before the given time.

@xref{SRFI-19 Time procedures}, for another way to compute with time
difference by @code{add-duration}/@code{subtract-duration}.
@c JP
与えられた@var{time}より@var{x}秒後を表すtimeオブジェクトを作って返します。
返されるtimeオブジェクトの型は@var{time}と同じです。
@var{x}は有限の実数でなければなりません。@var{x}が負の場合は、
与えられた時間より前の時間が返ります。

時間の計算には、SRFI-19の@code{add-duration}/@code{subtract-duration}
も使えます。@ref{SRFI-19 Time procedures}を参照してください。
@c COMMON
@end defun

@defun absolute-time obj
@defun absolute-time obj :optional current-time
@c EN
The argument must be either a @code{<time>} object, a real number,
or @code{#f}. If it is a @code{<time>} object, it specifies
an absolute point of time. If it is a real number, it specifies
or @code{#f}. If it is an absolute @code{<time>} object, it specifies
an absolute point of time. If it is a @code{<time>} object of
@code{time-duration} type, it is taken as a relative tiem from the current time.
If it is a real number, it specifies
the number of seconds from the current time.

This procedure returns @code{#f} if the argument is @code{#f},
Expand All @@ -32109,7 +32090,8 @@ real number or @code{#f}. This procedure is useful to process
such argument in the same way.
@c JP
引数は@code{<time>}オブジェクト、実数、もしくは@code{#f}でなければなりません。
@code{<time>}オブジェクトの場合は絶対時刻を、
絶対時刻を表す@code{<time>}オブジェクトの場合は絶対時刻を、
@code{time-duration}型の@code{<time>}オブジェクトの場合は現在時刻からの相対時間を、
実数の場合は現在時刻からの相対秒数を示します。

この手続きは、引数が@code{#f}なら@code{#f}を、そうでなければ
Expand All @@ -32118,8 +32100,41 @@ such argument in the same way.
timeout引数を取る多くの手続きが、同じ形式の引数を取ります。
この手続きはそれらと同様に時刻を扱うのに便利です。
@c COMMON

@c EN
The optional @var{current-time} is, if provided, must be an
absolute @code{<time>} object or @code{#f}. If it is a @code{<time>}
object, it is used as the current time instead of the actual current time.
@c JP
省略可能な@var{current-time}オブジェクトは、もし与えられたなら
絶対時刻の@code{<time>}オブジェクトか@code{#f}でなければなりません。
@code{<time>}オブジェクトの場合は、実際の現在時刻のかわりに
それが現在時刻として使われます。
@c COMMON
@end defun

@defun seconds+ time x
[SRFI-226]
@c EN
Returns a time object that is @var{x} seconds after the given @var{time}.
The type of returned time object is the same as @var{time}.
The argument @var{x} must be a finite real number. If it is negative,
returnd time is before the given time.

@xref{SRFI-19 Time procedures}, for another way to compute with time
difference by @code{add-duration}/@code{subtract-duration}.
@c JP
与えられた@var{time}より@var{x}秒後を表すtimeオブジェクトを作って返します。
返されるtimeオブジェクトの型は@var{time}と同じです。
@var{x}は有限の実数でなければなりません。@var{x}が負の場合は、
与えられた時間より前の時間が返ります。

時間の計算には、SRFI-19の@code{add-duration}/@code{subtract-duration}
も使えます。@ref{SRFI-19 Time procedures}を参照してください。
@c COMMON
@end defun


@defun time->seconds time
@defunx seconds->time seconds
[SRFI-18][SRFI-21]
Expand Down

0 comments on commit a9397c3

Please sign in to comment.