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

tools.annotations: document the fact that certain words should not be annotated

db4
Slava Pestov 2009-09-08 20:49:12 -05:00
parent 410d2bf0d0
commit 7473983383
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
basis/tools/annotations/annotations-docs.factor
View File

@ -16,7 +16,10 @@ $nl
{ $subsection add-timing }
{ $subsection word-timing. }
"All of the above words are implemented using a single combinator which applies a quotation to a word definition to yield a new definition:"
{ $subsection annotate } ;
{ $subsection annotate }
{ $warning
"Certain internal words, such as words in the " { $vocab-link "math" } ", " { $vocab-link "sequences" } " and UI vocabularies, cannot be annotated, since the annotated code may end up recursively invoking the word in question. This may crash or hang Factor. It is safest to only define annotations on your own words."
} ;
ABOUT: "tools.annotations"