Give 'syntax-propertize-wholelines' a docstring.

This function is generally useful.

* lisp/emacs-lisp/syntax.el (syntax-propertize-wholelines): Add
docstring.

1 files changed, 4 insertions, 0 deletions

diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el
index 6d5b04b83bb..0bb1b8916b1 100644
--- a/lisp/emacs-lisp/syntax.el
+++ b/lisp/emacs-lisp/syntax.el
@@ -125,6 +125,10 @@ otherwise nil.  That construct can be a two character comment
 delimiter or an Escaped or Char-quoted character."))
 
 (defun syntax-propertize-wholelines (start end)
+  "Extend the region delimited by START and END to whole lines.
+This function is useful for
+`syntax-propertize-extend-region-functions';
+see Info node `(elisp) Syntax Properties'."
   (goto-char start)
   (cons (line-beginning-position)
         (progn (goto-char end)