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

tools.walker: Improve docs for breakpoint words

char-rename
Sankaranarayanan Viswanathan 2016-10-06 22:45:11 -04:00 committed by John Benediktsson
parent 25a9b9a92a
commit fe9ceffad5
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
basis/tools/walker/walker-docs.factor
View File

@ -1,9 +1,9 @@
IN: tools.walker
USING: help.syntax help.markup tools.continuations sequences math words ;
USING: help.syntax help.markup tools.annotations tools.continuations sequences math words ;
HELP: breakpoint
{ $values { "word" word } }
{ $description "Annotates a word definition to enter the single stepper when executed." }
{ $description "Annotates a word definition to enter the single stepper when executed. Use " { $link reset } " to clear." }
{ $examples
{ $unchecked-example "USE: tools.walker \\ sq breakpoint"
""
@ -12,7 +12,7 @@ HELP: breakpoint
HELP: breakpoint-if
{ $values { "word" word } { "quot" { $quotation ( -- ? ) } } }
{ $description "Annotates a word definition to enter the single stepper if the quotation yields true. The quotation has access to the datastack as it exists just before " { $snippet "word" } " is called." }
{ $description "Annotates a word definition to enter the single stepper if the quotation yields true. The quotation has access to the datastack as it exists just before " { $snippet "word" } " is called. Use " { $link reset } " to clear." }
{ $examples
"Break if the input to sq is 3:"
{ $unchecked-example