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

Adding documentation for ad-do-it

db4
James Cash 2008-11-08 13:38:56 -05:00
parent cc877bf79b
commit ec7bc276dc
1 changed files with 6 additions and 1 deletions
extra/advice

7
extra/advice/advice-docs.factor
View 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." ;