From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Thu, 28 Apr 2016 11:00:11 +0000 (+0200)
Subject: Clarify some doc strings
X-Git-Tag: emacs-26.0.90~2130
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ad3ef417f3c40f086de9c547d6272e5685595e42;p=emacs.git

Clarify some doc strings

* lisp/emacs-lisp/syntax.el (syntax-propertize-via-font-lock):
Clarify doc string (bug#8693).
(syntax-propertize): Clarify doc string.
---

diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el
index c221a017f51..ae682ecf73a 100644
--- a/lisp/emacs-lisp/syntax.el
+++ b/lisp/emacs-lisp/syntax.el
@@ -272,9 +272,10 @@ Note: back-references in REGEXPs do not work."
          (cond ,@(nreverse branches))))))
 
 (defun syntax-propertize-via-font-lock (keywords)
-  "Propertize for syntax in START..END using font-lock syntax.
+  "Propertize for syntax using font-lock syntax.
 KEYWORDS obeys the format used in `font-lock-syntactic-keywords'.
-The return value is a function suitable for `syntax-propertize-function'."
+The return value is a function (with two paremeters, START and
+END) suitable for `syntax-propertize-function'."
   (lambda (start end)
     (with-no-warnings
       (let ((font-lock-syntactic-keywords keywords))
@@ -283,7 +284,7 @@ The return value is a function suitable for `syntax-propertize-function'."
         (setq keywords font-lock-syntactic-keywords)))))
 
 (defun syntax-propertize (pos)
-  "Ensure that syntax-table properties are set until POS."
+  "Ensure that syntax-table properties are set until POS (a buffer point)."
   (when (< syntax-propertize--done pos)
     (if (null syntax-propertize-function)
         (setq syntax-propertize--done (max (point-max) pos))