From e63d82ce65acded508a0c1fdeec73b9ebcfeb20f Mon Sep 17 00:00:00 2001 From: Kevin Ushey Date: Wed, 10 Jul 2024 17:25:59 +0800 Subject: [PATCH] rebuild docs --- man/showDialog.Rd | 2 +- man/showPrompt.Rd | 5 ++++- man/showQuestion.Rd | 5 ++++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/man/showDialog.Rd b/man/showDialog.Rd index 04728c2..efeeaf4 100644 --- a/man/showDialog.Rd +++ b/man/showDialog.Rd @@ -15,7 +15,7 @@ dialog area. Contents can contain the following HTML tags: "p", "em", \item{url}{An optional URL to display under the \code{message}.} -\item{timeout}{An optional timeout (in seconds). When set, if the user takes +\item{timeout}{A timeout (in seconds). When set, if the user takes longer than this timeout to provide a response, the request will be aborted.} } \description{ diff --git a/man/showPrompt.Rd b/man/showPrompt.Rd index 70e4465..762d94c 100644 --- a/man/showPrompt.Rd +++ b/man/showPrompt.Rd @@ -4,7 +4,7 @@ \alias{showPrompt} \title{Show Prompt Dialog Box} \usage{ -showPrompt(title, message, default = NULL) +showPrompt(title, message, default = NULL, timeout = 60) } \arguments{ \item{title}{The title to display in the dialog box.} @@ -14,6 +14,9 @@ dialog area.} \item{default}{An optional character vector that fills the prompt field with a default value.} + +\item{timeout}{A timeout (in seconds). When set, if the user takes +longer than this timeout to provide a response, the request will be aborted.} } \description{ Shows a dialog box with a prompt field. diff --git a/man/showQuestion.Rd b/man/showQuestion.Rd index 6c54f3a..0d10862 100644 --- a/man/showQuestion.Rd +++ b/man/showQuestion.Rd @@ -4,7 +4,7 @@ \alias{showQuestion} \title{Show Question Dialog Box} \usage{ -showQuestion(title, message, ok = NULL, cancel = NULL) +showQuestion(title, message, ok = NULL, cancel = NULL, timeout = 60) } \arguments{ \item{title}{The title to display in the dialog box.} @@ -17,6 +17,9 @@ OK button.} \item{cancel}{An optional character vector that overrides the caption for the Cancel button.} + +\item{timeout}{A timeout (in seconds). When set, if the user takes +longer than this timeout to provide a response, the request will be aborted.} } \description{ Shows a dialog box asking a question.