diff options
author | Stefan Monnier <monnier@iro.umontreal.ca> | 2013-05-30 09:57:44 -0400 |
---|---|---|
committer | Stefan Monnier <monnier@iro.umontreal.ca> | 2013-05-30 09:57:44 -0400 |
commit | 539240a694d19badf0d3d0547a9c78ba95f3c692 (patch) | |
tree | 7ba882f284bf2fc00a6046d92e8e87eb7d25b2f8 /lisp/emacs-lisp | |
parent | bee07d4ff7760e0099763a601ba185304ffe014b (diff) | |
download | emacs-539240a694d19badf0d3d0547a9c78ba95f3c692.tar.gz emacs-539240a694d19badf0d3d0547a9c78ba95f3c692.tar.bz2 emacs-539240a694d19badf0d3d0547a9c78ba95f3c692.zip |
* syntax.el (syntax-propertize-function): Fix docstring.
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r-- | lisp/emacs-lisp/syntax.el | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el index 0a4758a9ccd..3e850320133 100644 --- a/lisp/emacs-lisp/syntax.el +++ b/lisp/emacs-lisp/syntax.el @@ -56,12 +56,13 @@ ;; syntax-ppss-flush-cache since that would not only flush the cache but also ;; reset syntax-propertize--done which should not be done in this case). "Mode-specific function to apply `syntax-table' text properties. -The value of this variable is a function to be called by Font -Lock mode, prior to performing syntactic fontification on a -stretch of text. It is given two arguments, START and END: the -start and end of the text to be fontified. Major modes can -specify a custom function to apply `syntax-table' properties to -override the default syntax table in special cases. +It is the work horse of `syntax-propertize', which is called by things like +Font-Lock and indentation. + +It is given two arguments, START and END: the start and end of the text to +which `syntax-table' might need to be applied. Major modes can use this to +override the buffer's syntax table for special syntactic constructs that +cannot be handled just by the buffer's syntax-table. The specified function may call `syntax-ppss' on any position before END, but it should not call `syntax-ppss-flush-cache', |