From c8126ec17ed6ac1af77fa95a55527d5b932bc83c Mon Sep 17 00:00:00 2001 From: Alexander Iljin Date: Tue, 20 Sep 2016 22:21:37 +0300 Subject: [PATCH] help-docs: describe $unchecked-example --- basis/help/help-docs.factor | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/basis/help/help-docs.factor b/basis/help/help-docs.factor index 7d449f16ba..84b1e8d684 100644 --- a/basis/help/help-docs.factor +++ b/basis/help/help-docs.factor @@ -1,6 +1,6 @@ -USING: arrays help.crossref help.markup help.stylesheet -help.syntax help.topics io kernel math prettyprint quotations -see sequences strings summary vocabs ; +USING: arrays help.crossref help.lint help.markup +help.stylesheet help.syntax help.topics io kernel math +prettyprint quotations see sequences strings summary vocabs ; IN: help ARTICLE: "printing-elements" "Printing markup elements" @@ -316,7 +316,12 @@ HELP: $example "However the following is right:" { $markup-example { $example "USING: math prettyprint ;" "2 2 + ." "4" } } "Examples can incorporate a call to " { $link .s } " to show multiple output values; the convention is that you may assume the stack is empty before the example evaluates." -} ; +} +{ $see-also $unchecked-example } ; + +HELP: $unchecked-example +{ $values { "element" object } } +{ $description "Same as " { $link $example } ", except " { $link help-lint } " ignores its contents and doesn't try to run the code and verify its output." } ; HELP: $markup-example { $values { "element" "a markup element" } }