mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-04-25 15:52:01 -07:00
Code Issues Projects Releases Wiki Activity

Clarify some doc strings

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

(cherry picked from commit ad3ef417f3)
This commit is contained in:
Lars Ingebrigtsen 2016-04-28 13:00:11 +02:00
parent 351c079cf6
commit 0a14d84150
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lisp/emacs-lisp/syntax.el
View file

@ -272,9 +272,10 @@ Note: back-references in REGEXPs do not work."
(cond ,@(nreverse branches)))))) (cond ,@(nreverse branches))))))
(defun syntax-propertize-via-font-lock (keywords) (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'. 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) (lambda (start end)
(with-no-warnings (with-no-warnings
(let ((font-lock-syntactic-keywords keywords)) (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))))) (setq keywords font-lock-syntactic-keywords)))))
(defun syntax-propertize (pos) (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) (when (< syntax-propertize--done pos)
(if (null syntax-propertize-function) (if (null syntax-propertize-function)
(setq syntax-propertize--done (max (point-max) pos)) (setq syntax-propertize--done (max (point-max) pos))