diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2016-04-28 13:00:11 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2016-04-28 13:00:11 +0200 |
| commit | ad3ef417f3c40f086de9c547d6272e5685595e42 (patch) | |
| tree | d67a2fb0382c7dbe99e4b43c118caa56fc87f8e2 /lisp/emacs-lisp | |
| parent | 786ab4a5ca0a326a1c2d44dcbfed8427f7783062 (diff) | |
| download | emacs-ad3ef417f3c40f086de9c547d6272e5685595e42.tar.gz emacs-ad3ef417f3c40f086de9c547d6272e5685595e42.tar.bz2 emacs-ad3ef417f3c40f086de9c547d6272e5685595e42.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.
Diffstat (limited to 'lisp/emacs-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 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)) |