kernel: clarify docs for while*

diff --git a/core/kernel/kernel-docs.factor b/core/kernel/kernel-docs.factor
index 107b911a3cc3199114bb678668002f544037a8aa..206b248022daa3d8be93de3f49d18c2be3e5d479 100644 (file)
--- a/core/kernel/kernel-docs.factor
+++ b/core/kernel/kernel-docs.factor
@@ -999,7 +999,9 @@ HELP: while
 
 HELP: while*
 { $values { "pred" { $quotation ( ..a -- ..b ? ) } } { "body" { $quotation ( ..b ? -- ..a ) } } }
-{ $description "Calls " { $snippet "body" } " until " { $snippet "pred" } " returns " { $link f } "." } ;
+{ $description "Calls " { $snippet "body" } " until " { $snippet "pred" }
+  " returns " { $link f } ". The return value of " { $snippet "pred" } " is "
+  "kept on the stack." } ;
 
 HELP: until
 { $values { "pred" { $quotation ( ..a -- ..b ? ) } } { "body" { $quotation ( ..b -- ..a ) } } }