From b9bced9a5ed4c9e60c7de80facd48e27c41509b4 Mon Sep 17 00:00:00 2001 From: Joe Groff Date: Tue, 9 Mar 2010 18:42:10 -0800 Subject: [PATCH] update docs for unbalanced-branches-error --- basis/stack-checker/errors/errors-docs.factor | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/basis/stack-checker/errors/errors-docs.factor b/basis/stack-checker/errors/errors-docs.factor index 9aa7ed0d14..4f1bb28c5e 100644 --- a/basis/stack-checker/errors/errors-docs.factor +++ b/basis/stack-checker/errors/errors-docs.factor @@ -63,15 +63,16 @@ HELP: bad-macro-input } ; HELP: unbalanced-branches-error -{ $values { "in" "a sequence of integers" } { "out" "a sequence of integers" } } -{ $description "Throws an " { $link unbalanced-branches-error } "." } -{ $error-description "Thrown when inference encounters an " { $link if } " or " { $link dispatch } " where the branches do not all exit with the same stack height. See " { $link "inference-branches" } " for details." } -{ $notes "If this error comes up when inferring the stack effect of a recursive word, check the word's stack effect declaration; it might be wrong." } +{ $error-description "Thrown when inference encounters an inline combinator whose input quotations do not match their declared effects, or when it encounters an " { $link if } " or " { $link dispatch } " whose branches do not all exit with the same stack height. See " { $link "inference-combinators" } " and " { $link "inference-branches" } " for details." } { $examples { $code - ": unbalanced-branches-example ( a b c -- )" + ": if-unbalanced-branches-example ( a b c -- )" " [ + ] [ dup ] if ;" } + { $code + ": each-unbalanced-branches-example ( x seq -- x' )" + " [ 3append ] each ;" + } } ; HELP: too-many->r