From: John Benediktsson Date: Wed, 26 Jan 2022 18:43:54 +0000 (-0800) Subject: syntax: adding documentation for STARTUP-HOOK: and SHUTDOWN-HOOK: X-Git-Tag: 0.99~1625 X-Git-Url: https://gitweb.factorcode.org/gitweb.cgi?p=factor.git;a=commitdiff_plain;h=a1071051d03231dd6e1991f8d4366fb422d2f84b syntax: adding documentation for STARTUP-HOOK: and SHUTDOWN-HOOK: --- diff --git a/core/syntax/syntax-docs.factor b/core/syntax/syntax-docs.factor index f98a694cf1..6601811f9d 100644 --- a/core/syntax/syntax-docs.factor +++ b/core/syntax/syntax-docs.factor @@ -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." } ;