Merge pull request #4285 from akirabaruah/docs

core-lib: Add docstring for add-hook-trigger!
This commit is contained in:
Henrik Lissner 2020-11-20 15:29:08 -05:00 committed by GitHub
commit ce66ac4130
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -488,7 +488,12 @@ advised)."
(add-hook sym #',fn ,append)))))) (add-hook sym #',fn ,append))))))
(defmacro add-hook-trigger! (hook-var &rest targets) (defmacro add-hook-trigger! (hook-var &rest targets)
"TODO" "Configure HOOK-VAR to be invoked exactly once after init whenever any of the
TARGETS are invoked. Once HOOK-VAR gets triggered, it resets to nil.
HOOK-VAR is a quoted hook.
TARGETS is a list of quoted hooks and/or sharp-quoted functions."
`(let ((fn (intern (format "%s-h" ,hook-var)))) `(let ((fn (intern (format "%s-h" ,hook-var))))
(fset (fset
fn (lambda (&rest _) fn (lambda (&rest _)