]> git.eshelyaron.com Git - emacs.git/commitdiff
; Elaborate on tree-sitter fontification features documentation
authorYuan Fu <casouri@gmail.com>
Thu, 17 Nov 2022 05:31:04 +0000 (21:31 -0800)
committerYuan Fu <casouri@gmail.com>
Thu, 17 Nov 2022 18:11:20 +0000 (10:11 -0800)
* doc/lispref/modes.texi (Parser-based Font Lock)
* lisp/treesit.el (treesit-font-lock-feature-list): Explain in more
detail, and change some features.

doc/lispref/modes.texi
lisp/treesit.el

index 71687b0783d044fa45e01e4f99fbe2b52719e2d1..8b20bc0b758c333292738e0b97bee047a78dc570 100644 (file)
@@ -4077,11 +4077,20 @@ Each element of the list is a list of the form @w{@code{(@var{feature}
 list disables the corresponding query during font-lock.
 
 Common feature names, for many programming languages, include
-function-name, type, variable-name (left-hand-side or @acronym{LHS} of
-assignments), builtin, constant, keyword, string-interpolation,
-comment, doc, string, operator, preprocessor, escape-sequence, and key
-(in key-value pairs).  Major modes are free to subdivide or extend
-these common features.
+@code{definition}, @code{type}, @code{assignment}, @code{builtin},
+@code{constant}, @code{keyword}, @code{string-interpolation},
+@code{comment}, @code{doc}, @code{string}, @code{operator},
+@code{preprocessor}, @code{escape-sequence}, and @code{key}.  Major
+modes are free to subdivide or extend these common features.
+
+Some of these features warrant some explanation: @code{definition}
+highlights whatever is being defined, e.g., the function name in a
+function definition, the struct name in a struct definition, the
+variable name in a variable definition; @code{assignment} highlights
+the whatever is being assigned to, e.g., the variable or field in an
+assignment statement; @code{key} highlights keys in key-value pairs,
+e.g., keys in a JSON object, or a Python dictionary; @code{doc}
+highlights docstrings or doc-comments.
 
 For example, the value of this variable could be:
 @example
index 1284afe84bc29d889ca9510bd2a28b7d5838649f..6a41c1a41137e04f7edacfc13694d2eb923941ed 100644 (file)
@@ -542,11 +542,11 @@ Removing a feature symbol from this list disables the
 corresponding query during font-lock.
 
 Common feature names (for general programming languages) include
-function-name, type, variable-name (LHS of assignments), builtin,
-constant, keyword, string-interpolation, comment, doc, string,
-operator, preprocessor, escape-sequence, key (in key-value
-pairs).  Major modes are free to subdivide or extend on these
-common features.
+definition, type, assignment, builtin, constant, keyword,
+string-interpolation, comment, doc, string, operator, property,
+preprocessor, escape-sequence, key (in key-value pairs).  Major
+modes are free to subdivide or extend on these common features.
+See the manual for more explanations on some of the feature.
 
 For changes to this variable to take effect, run
 `treesit-font-lock-recompute-features'.")