continuations: document full effect of cleanup

[factor.git] / core / continuations / continuations-docs.factor

diff --git a/core/continuations/continuations-docs.factor b/core/continuations/continuations-docs.factor
index 8bcc7c754e639cd34f0b6f42d958cc1c35df3989..c6ba9b66a23177393efad7968b5f95b9f567f4a7 100644 (file)
--- a/core/continuations/continuations-docs.factor
+++ b/core/continuations/continuations-docs.factor
@@ -170,7 +170,7 @@ HELP: throw
 { cleanup recover } related-words
 
 HELP: cleanup
-{ $values { "try" quotation } { "cleanup-always" quotation } { "cleanup-error" quotation } }
+{ $values { "try" { $quotation "( ..a -- ..a )" } } { "cleanup-always" { $quotation "( ..a -- ..b )" } } { "cleanup-error" { $quotation "( ..b -- ..b )" } } }
 { $description "Calls the " { $snippet "try" } " quotation. If no error is thrown, calls " { $snippet "cleanup-always" } " without restoring the data stack. If an error is thrown, restores the data stack, calls " { $snippet "cleanup-always" } " followed by " { $snippet "cleanup-error" } ", and rethrows the error." } ;
 
 HELP: recover