Skip to content

Commit

Permalink
syntax: adding documentation for STARTUP-HOOK: and SHUTDOWN-HOOK:
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjbq7 committed Jan 26, 2022
1 parent 404ac5b commit a107105
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions core/syntax/syntax-docs.factor
Expand Up @@ -1028,3 +1028,11 @@ HELP: IDENTITY-MEMO::
{ $syntax "IDENTITY-MEMO:: word ( stack -- effect ) definition... ;" }
{ $values { "word" "a new word to define" } { "definition" "a word definition" } }
{ $description "Defines the given word at parse time as one which memoizes its output given a particular input with locals which is identical to another input. The stack effect is mandatory." } ;

HELP: STARTUP-HOOK:
{ $syntax "STARTUP-HOOK: word/quotation" }
{ $description "Parses a word or a quotation and sets it as the startup hook for the current vocabulary." } ;

HELP: SHUTDOWN-HOOK:
{ $syntax "SHUTDOWN-HOOK: word/quotation" }
{ $description "Parses a word or a quotation and sets it as the shutdown hook for the current vocabulary." } ;

0 comments on commit a107105

Please sign in to comment.