]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify abnormal hook documentation
authorStefan Kangas <stefan@marxist.se>
Sat, 23 Oct 2021 18:03:34 +0000 (20:03 +0200)
committerStefan Kangas <stefan@marxist.se>
Sat, 23 Oct 2021 18:03:34 +0000 (20:03 +0200)
* doc/lispref/hooks.texi (Standard Hooks):
* doc/lispref/modes.texi (Hooks): Clarify wording of "abnormal
hook" documentation.  (Bug#34588)

doc/lispref/hooks.texi
doc/lispref/modes.texi

index feec8b24f464acc1f2428b4b47344a30bed4756d..e9d1e270d8ec3bf2baf92ba24245e4bad3c6aee8 100644 (file)
@@ -18,11 +18,13 @@ arguments and their values are completely ignored.  The recommended way
 to put a new function on such a hook is to call @code{add-hook}.
 @xref{Hooks}, for more information about using hooks.
 
-The variables whose names end in @samp{-functions} are usually @dfn{abnormal
-hooks} (some old code may also use the deprecated @samp{-hooks} suffix); their
-values are lists of functions, but these functions are called in a special way
-(they are passed arguments, or their return values are used).  The variables
-whose names end in @samp{-function} have single functions as their values.
+The variables whose names end in @samp{-functions} are usually
+@dfn{abnormal hooks} (some old code may also use the deprecated
+@samp{-hooks} suffix).  Their values are lists of functions, but these
+functions are called in a special way: they are either passed
+arguments, or their return values are used in some way.  The variables
+whose names end in @samp{-function} have single functions as their
+values.
 
 This is not an exhaustive list, it only covers the more general hooks.
 For example, every major mode defines a hook named
index ee55f982d0292c43d790c38af30bfb3b86f382c8..ed0c535867fd42ab3374c3ce3a1df9dee5a0dbc5 100644 (file)
@@ -59,12 +59,12 @@ runs just before Emacs suspends itself (@pxref{Suspending Emacs}).
 
 @cindex abnormal hook
   If the hook variable's name does not end with @samp{-hook}, that
-indicates it is probably an @dfn{abnormal hook}.  That means the hook
-functions are called with arguments, or their return values are used
-in some way.  The hook's documentation says how the functions are
-called.  Any functions added to an abnormal hook must follow the
-hook's calling convention.  By convention, abnormal hook names end in
-@samp{-functions}.
+indicates it is probably an @dfn{abnormal hook}.  That means one of
+two things: either that the hook functions are called with arguments,
+or that their return values are used in some way.  The hook's
+documentation says how the functions are called.  Any functions added
+to an abnormal hook must follow the hook's calling convention.  By
+convention, abnormal hook names end in @samp{-functions}.
 
 @cindex single-function hook
 If the name of the variable ends in @samp{-predicate} or