GNU bug report logs - #24734
[PATCH] Minor improvement of the doc of lisp/paren.el.

Previous Next

Full log

View this message in rfc822 format

From: Hong Xu <hong <at> topbug.net>
To: 24734 <at> debbugs.gnu.org
Cc: Hong Xu <hong <at> topbug.net>
Subject: bug#24734: [PATCH] Minor improvement of the doc of lisp/paren.el.
Date: Tue, 18 Oct 2016 13:16:58 -0700

---

These are my suggested imporvements of the docs in lisp/paren.el, after
I looked into the code for the first time.

---
 lisp/paren.el | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lisp/paren.el b/lisp/paren.el
index 53eb50077f25..f0df1ff2ea4d 100644
--- a/lisp/paren.el
+++ b/lisp/paren.el
@@ -181,6 +181,7 @@ show-paren-data-function
 Where HERE-BEG..HERE-END is expected to be near point.")
 
 (defun show-paren--default ()
+  "The default value of `show-paren-data-function'."
   (let* ((temp (show-paren--locate-near-paren))
 	 (dir (car temp))
 	 (outside (cdr temp))
@@ -233,9 +234,8 @@ show-paren--default
 		  (if (= dir 1) pos (1+ pos))
 		  mismatch)))))))
 
-;; Find the place to show, if there is one,
-;; and show it until input arrives.
 (defun show-paren-function ()
+  "Highlight the parentheses until the next input arrives."
   (let ((data (and show-paren-mode (funcall show-paren-data-function))))
     (if (not data)
         (progn
-- 
2.1.4

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.