diff options
| author | Lars Ingebrigtsen | 2016-04-28 13:00:11 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2016-05-01 19:27:07 +0200 |
| commit | 0a14d84150e7728ff1461d3f25b1b5bdc6e0cf08 (patch) | |
| tree | 64e373daf6c4dc8beaa8f40407debc265306cac9 /lisp | |
| parent | 351c079cf69d41b473edba43e0e960bd5a175273 (diff) | |
| download | emacs-0a14d84150e7728ff1461d3f25b1b5bdc6e0cf08.tar.gz emacs-0a14d84150e7728ff1461d3f25b1b5bdc6e0cf08.zip | |
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)
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/emacs-lisp/syntax.el | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el index e20a210de71..33f644191b6 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." | |||
| 272 | (cond ,@(nreverse branches)))))) | 272 | (cond ,@(nreverse branches)))))) |
| 273 | 273 | ||
| 274 | (defun syntax-propertize-via-font-lock (keywords) | 274 | (defun syntax-propertize-via-font-lock (keywords) |
| 275 | "Propertize for syntax in START..END using font-lock syntax. | 275 | "Propertize for syntax using font-lock syntax. |
| 276 | KEYWORDS obeys the format used in `font-lock-syntactic-keywords'. | 276 | KEYWORDS obeys the format used in `font-lock-syntactic-keywords'. |
| 277 | The return value is a function suitable for `syntax-propertize-function'." | 277 | The return value is a function (with two paremeters, START and |
| 278 | END) suitable for `syntax-propertize-function'." | ||
| 278 | (lambda (start end) | 279 | (lambda (start end) |
| 279 | (with-no-warnings | 280 | (with-no-warnings |
| 280 | (let ((font-lock-syntactic-keywords keywords)) | 281 | (let ((font-lock-syntactic-keywords keywords)) |
| @@ -283,7 +284,7 @@ The return value is a function suitable for `syntax-propertize-function'." | |||
| 283 | (setq keywords font-lock-syntactic-keywords))))) | 284 | (setq keywords font-lock-syntactic-keywords))))) |
| 284 | 285 | ||
| 285 | (defun syntax-propertize (pos) | 286 | (defun syntax-propertize (pos) |
| 286 | "Ensure that syntax-table properties are set until POS." | 287 | "Ensure that syntax-table properties are set until POS (a buffer point)." |
| 287 | (when (< syntax-propertize--done pos) | 288 | (when (< syntax-propertize--done pos) |
| 288 | (if (null syntax-propertize-function) | 289 | (if (null syntax-propertize-function) |
| 289 | (setq syntax-propertize--done (max (point-max) pos)) | 290 | (setq syntax-propertize--done (max (point-max) pos)) |