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

stack-checker.dependencies: +definition+ can't use $class-description. 

Also, placeholders for +effect+ and +conditional+.
char-rename
John Benediktsson 2016-11-28 09:38:44 -08:00
parent d6eb6f2c76
commit ae09790c7c
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
basis/stack-checker/dependencies/dependencies-docs.factor
View File

@ -2,7 +2,13 @@ USING: help.markup help.syntax ;
IN: stack-checker.dependencies
HELP: +definition+
{ $class-description "Word that indicates that the dependency is a definition dependency. It is a dependency among two words in which one word depends on the definition of the another. For example, if two words are defined as " { $snippet ": o ( -- ) i ;" } " and " { $snippet ": i ( -- ) ; inline" } ", then 'o' has a definition dependency to 'i' because 'i' is inline. If the definition of 'i' changes 'o' must be recompiled." } ;
{ $description "Word that indicates that the dependency is a definition dependency. It is a dependency among two words in which one word depends on the definition of the another. For example, if two words are defined as " { $snippet ": o ( -- ) i ;" } " and " { $snippet ": i ( -- ) ; inline" } ", then 'o' has a definition dependency to 'i' because 'i' is inline. If the definition of 'i' changes 'o' must be recompiled." } ;
HELP: +effect+
{ $description "Word that indicates that the dependency is an effect dependency." } ;
HELP: +conditional+
{ $description "Word that indicates that the dependency is a conditional dependency." } ;
HELP: dependencies
{ $var-description "Words that the current quotation depends on." } ;