emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] emacs-25 0a14d84 04/64: Clarify some doc strings


From: Lars Ingebrigtsen
Subject: [Emacs-diffs] emacs-25 0a14d84 04/64: Clarify some doc strings
Date: Sun, 01 May 2016 18:18:39 +0000

branch: emacs-25
commit 0a14d84150e7728ff1461d3f25b1b5bdc6e0cf08
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    Clarify some doc strings
    
    * lisp/emacs-lisp/syntax.el (syntax-propertize-via-font-lock):
    Clarify doc string (bug#8693).
    (syntax-propertize): Clarify doc string.
    
    (cherry picked from commit ad3ef417f3c40f086de9c547d6272e5685595e42)
---
 lisp/emacs-lisp/syntax.el |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el
index e20a210..33f6441 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))



reply via email to

[Prev in Thread] Current Thread [Next in Thread]