From 771637559a1c0440757ad78c62ea9e736ec6a8ba Mon Sep 17 00:00:00 2001 From: Ricardo Wurmus Date: Tue, 16 Feb 2021 17:25:39 +0100 Subject: low: wait: Add docstring, make TIMEOUT argument optional. --- drmaa/v1/low.scm | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/drmaa/v1/low.scm b/drmaa/v1/low.scm index 624c018..3003052 100644 --- a/drmaa/v1/low.scm +++ b/drmaa/v1/low.scm @@ -476,7 +476,17 @@ the current session will be affected." (DRMAA 'ERROR_STRING_BUFFER)) #true error-message))) -(define (wait job-id timeout) +(define* (wait job-id #:optional timeout) + "Wait for the completion of a job with identifier JOB-ID. If the +JOB-ID is the special symbol '*, wait for the completion of any job +that has been submitted during this session. + +TIMEOUT (an integer) specifies the number of seconds to block. If it +is not provided or is #FALSE this procedure will block forever. + +This procedure returns three values: the identifier of the job that +has completed, the status code of the job (an opaque value), and an +alist of resource usage statistics." (let ((timeout (or timeout (DRMAA 'TIMEOUT_WAIT_FOREVER))) (job-id-out -- cgit v1.2.3