From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 27 Jul 2019 13:59:32 +0000 (+0200)
Subject: Add a doc string to redisplay-highlight-region-function
X-Git-Tag: emacs-27.0.90~1817^2~72
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=70f83a141048c9b6fd119c1999a2113a0ab66e91;p=emacs.git

Add a doc string to redisplay-highlight-region-function

* lisp/simple.el (redisplay-highlight-region-function): Add a doc
string (bug#24701).
---

diff --git a/lisp/simple.el b/lisp/simple.el
index 742d6cb6ff3..2c6fc84e73f 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -5614,6 +5614,13 @@ separate contiguous regions for each line."
   (lambda (rol) (when (overlayp rol) (delete-overlay rol))))
 
 (defvar redisplay-highlight-region-function
+  "Function to move the highlight overlay.
+This function is called with four parameters, START, END, WINDOW
+and OVERLAY.  If OVERLAY is nil, a new overlay is created.  In
+any case, the overlay is adjusted to reflect the other three
+parameters.
+
+The overlay is returned by the function."
   (lambda (start end window rol)
     (if (not (overlayp rol))
         (let ((nrol (make-overlay start end)))