bug#2217: [PATCH] add-log.el (add-log-current-defun-header-regexp): Improve docstring

[Jari Aalto]

Tags: patch

2009-02-06  Jari Aalto  <jari.aalto@cante.net>

       * add-log.el: Improve docstring by mentioning submatch 1.

>From d936b3faf4372e5538bee950f2145870196e257c Mon Sep 17 00:00:00 2001
From: Jari Aalto <jari.aalto@cante.net>
Date: Fri, 6 Feb 2009 06:01:53 +0200
Subject: [PATCH] lisp/add-log.el: (add-log-current-defun-header-regexp): 
Improve docstring

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
---
 lisp/add-log.el |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/lisp/add-log.el b/lisp/add-log.el
index 00e3172..c43a548 100644
--- a/lisp/add-log.el
+++ b/lisp/add-log.el
@@ -1095,7 +1095,9 @@ Prefix arg means justify as well."
 
 (defcustom add-log-current-defun-header-regexp
   "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]"
-  "Heuristic regexp used by `add-log-current-defun' for unknown major modes."
+  "Heuristic regexp used by `add-log-current-defun' for unknown major modes.
+The regular expression's submatch 1 is used for the text in '(parenthesis)'."
+text in '(parentheses)'."
   :type 'regexp
   :group 'change-log)
 
-- 
1.5.6.5