From ba57d1adcdc61e2caac7c441b0654452b8a7ff1f Mon Sep 17 00:00:00 2001 From: Jon Harper Date: Thu, 17 Oct 2013 00:24:28 +0200 Subject: [PATCH] with-ui docs, clearly state that the quot must return --- basis/ui/ui-docs.factor | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/basis/ui/ui-docs.factor b/basis/ui/ui-docs.factor index 0ae5df464d..f063336e38 100644 --- a/basis/ui/ui-docs.factor +++ b/basis/ui/ui-docs.factor @@ -75,7 +75,7 @@ HELP: raise-window HELP: with-ui { $values { "quot" { $quotation "( -- )" } } } -{ $description "Calls the quotation, starting the UI first if necessary. If the UI is started, this word does not return." } +{ $description "Calls the quotation, starting the UI if necessary. If starting the UI is necessary, this word does not return and the UI will start after the quotation returns." } { $notes "This word should be used in the " { $link POSTPONE: MAIN: } " word of an application that uses the UI in order for the vocabulary to work when run from either the UI listener (" { $snippet "\"my-app\" run" } ") and the command line (" { $snippet "./factor -run=my-app" } ")." } { $examples "The " { $vocab-link "hello-ui" } " vocabulary implements a simple UI application which uses this word." } ;