[Erc-commit] [commit][emacs22] erc-backend: Avoid gotcha in define-erc-response-handler

[mwolson]

commit 197ed9155ce6822ab949e4b3a4060a8d03e1ba02
Author: Michael Olson <address@hidden>
Date:   Thu Apr 12 04:33:35 2007 +0000

    erc-backend: Avoid gotcha in define-erc-response-handler
    
    2007-04-12  Michael Olson  <address@hidden>
    
        * erc-backend.el (define-erc-response-handler): Mention that hook
        processing stops when the function returns non-nil.  This should
        help avoid a nasty "gotcha" when making custom functions.  Thanks
        to John Sullivan for the report.
    git-archimport-id: address@hidden/erc--main--0--patch-139

diff --git a/ChangeLog b/ChangeLog
index 218c0f2..cb0fd66 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2007-04-12  Michael Olson  <address@hidden>
+
+       * erc-backend.el (define-erc-response-handler): Mention that hook
+       processing stops when the function returns non-nil.  This should
+       help avoid a nasty "gotcha" when making custom functions.  Thanks
+       to John Sullivan for the report.
+
 2007-04-08  Diane Murray  <address@hidden>
 
        * erc-nicklist.el (erc-nicklist-voiced-position): Fixed
diff --git a/erc-backend.el b/erc-backend.el
index 08cb738..7798d27 100644
--- a/erc-backend.el
+++ b/erc-backend.el
@@ -1054,8 +1054,11 @@ Would expand to:
       \"Some non-generic variable documentation.
 
   Hook called upon receiving a WHOIS server response.
+
   Each function is called with two arguments, the process associated
-  with the response and the parsed response.
+  with the response and the parsed response.  If the function returns
+  non-nil, stop processing the hook.  Otherwise, continue.
+
   See also `erc-server-311'.\")
 
     (defalias 'erc-server-WI 'erc-server-311)
@@ -1064,7 +1067,9 @@ Would expand to:
 
   Hook called upon receiving a WI server response.
   Each function is called with two arguments, the process associated
-  with the response and the parsed response.
+  with the response and the parsed response.  If the function returns
+  non-nil, stop processing the hook.  Otherwise, continue.
+
   See also `erc-server-311'.\"))
 
 \(fn (NAME &rest ALIASES) &optional EXTRA-FN-DOC EXTRA-VAR-DOC &rest FN-BODY)"
@@ -1078,7 +1083,9 @@ Would expand to:
          (fn-name (intern (format "erc-server-%s" name)))
          (hook-doc (format "%sHook called upon receiving a %%s server response.
 Each function is called with two arguments, the process associated
-with the response and the parsed response.
+with the response and the parsed response.  If the function returns
+non-nil, stop processing the hook.  Otherwise, continue.
+
 See also `%s'."
                            (if extra-var-doc
                                (concat extra-var-doc "\n\n")