steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

help-docs: describe $unchecked-example

char-rename
Alexander Iljin 2016-09-20 22:21:37 +03:00
parent da6ee64786
commit c8126ec17e
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
basis/help/help-docs.factor
View File

@ -1,6 +1,6 @@
USING: arrays help.crossref help.markup help.stylesheet USING: arrays help.crossref help.lint help.markup
help.syntax help.topics io kernel math prettyprint quotations help.stylesheet help.syntax help.topics io kernel math
see sequences strings summary vocabs ; prettyprint quotations see sequences strings summary vocabs ;
IN: help IN: help
ARTICLE: "printing-elements" "Printing markup elements" ARTICLE: "printing-elements" "Printing markup elements"
@ -316,7 +316,12 @@ HELP: $example
"However the following is right:" "However the following is right:"
{ $markup-example { $example "USING: math prettyprint ;" "2 2 + ." "4" } } { $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." "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 HELP: $markup-example
{ $values { "element" "a markup element" } } { $values { "element" "a markup element" } }