From 3727ec4f9a53d78c1be1c8eeb3e52f64f393aea0 Mon Sep 17 00:00:00 2001 From: Eli Barzilay Date: Fri, 1 Jan 2010 20:59:04 +0000 Subject: [PATCH] better text svn: r17459 --- .../handin-server/scribblings/utils.scrbl | 30 +++++++++++-------- 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/collects/handin-server/scribblings/utils.scrbl b/collects/handin-server/scribblings/utils.scrbl index d619b3a29d..c2423cb6f8 100644 --- a/collects/handin-server/scribblings/utils.scrbl +++ b/collects/handin-server/scribblings/utils.scrbl @@ -142,21 +142,27 @@ Every exception or result mismatch during the call to @defproc*[([(message [string string?]) void?] [(message [string string?] [styles 'final]) void?] [(message [string string?] - [styles (listof (or/c 'ok 'ok-cancel 'yes-no 'caution 'stop))]) + [styles (listof (or/c 'ok 'ok-cancel 'yes-no + 'caution 'stop))]) any])]{ - The first two cases of @scheme[message] update the top-line of the status - dialog on the client. If @scheme['final] is passed, then the - string argument is used as the as the text on the handin - dialog after a successful submission instead of ``Handin - successful.'' (useful for submissions that were saved, but had - problems). + The first case of @scheme[message] is intended to update the client on + the current activity --- it updates the status line in the submission + dialog box on the client. Use it to indicate operations that might + take a while and/or indicate progress during these operations. - The third case, when @scheme[styles] is a list of symbols, - opens a @scheme[message-box] dialog on the client side, and the - resulting value is returned as the result of @scheme[message]. The + In the second case, where @scheme['final] is used as a flag, does not + show the text immediately --- instead, it causes it to be displayed in + the status line after a successful submission instead of the usual + ``Handin successful'' message. This is useful for submissions that + are accepted but had some problems. + + The third case, when @scheme[styles] is a list of symbols, opens a + @scheme[message-box] dialog on the client side, and the resulting + value is returned as the result of @scheme[message]. The @scheme[styles] list is passed as the @scheme[style] argument to - @scheme[message-box]. You - can use this to send warnings to the student or ask confirmation.} + @scheme[message-box]. You can use this to send warnings to the + student or to ask for confirmation, for example, ``your submission + does not pass 3 tests, continue?''.} @defproc[(set-run-status [status (or/c false? string?)]) void?]{ Registers information about the current actions of the checker, in