]> gitweb.factorcode.org Git - factor.git/commitdiff
tools.walker: Improve docs for breakpoint words
authorSankaranarayanan Viswanathan <rationalrevolt@gmail.com>
Fri, 7 Oct 2016 02:45:11 +0000 (22:45 -0400)
committerJohn Benediktsson <mrjbq7@gmail.com>
Fri, 7 Oct 2016 23:05:04 +0000 (16:05 -0700)
basis/tools/walker/walker-docs.factor

index d47a858bf3afc5bf2aaec4828df12b6cb153b467..bcf287f820b05f9caef5699491db165a239a08e4 100644 (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