]> gitweb.factorcode.org Git - factor.git/commitdiff
Adding documentation for ad-do-it
authorJames Cash <james.nvc@gmail.com>
Sat, 8 Nov 2008 18:38:56 +0000 (13:38 -0500)
committerJames Cash <james.nvc@gmail.com>
Tue, 11 Nov 2008 07:33:19 +0000 (02:33 -0500)
extra/advice/advice-docs.factor

index 7b523e9a8c78d8e8f0ac655526ceba0370ead17a..2c470d04b32a90985037b44ec084714d6d500937 100644 (file)
@@ -1,5 +1,5 @@
 IN: advice
-USING: help.markup help.syntax tools.annotations words ;
+USING: help.markup help.syntax tools.annotations words coroutines ;
 
 HELP: make-advised
 { $values { "word" "a word to annotate in preparation of advising" } }
@@ -16,6 +16,11 @@ HELP: advised?
 { $values { "word" "a word" } { "?" "t or f, indicating if " { $snippet "word" } " is advised" } }
 { $description "Determines whether or not the given word has any advice on it." } ;
 
+HELP: ad-do-it
+{ $values { "input" "an object" } { "output" "an object" } }
+{ $description "Calls either the next applicable around advice or the main body, returning back to the point it was called from when finished.  This word should only be called from inside advice." }
+{ $see-also coyield } ;
+
 ARTICLE: "advice" "Advice"
 "Advice is a simple way of adding additition functionality to words by adding 'hooks' to a word, which can act before, after, or around the calling of the word." ;