branch: externals/indent-bars
commit fc8f49236498e4cef90f3d572b7c7192fb8fa6ee
Author: JD Smith <[email protected]>
Commit: JD Smith <[email protected]>
indent-bars-ts: improve commentary
---
indent-bars-ts.el | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/indent-bars-ts.el b/indent-bars-ts.el
index 4ba2973f1e..1a10522d58 100644
--- a/indent-bars-ts.el
+++ b/indent-bars-ts.el
@@ -10,8 +10,9 @@
;; - Uses treesitter to avoid adding bars to blank lines in strings
;; or other configurable node types.
;; - Enable alternate styling for bars inside or outside the
-;; treesitter "scope", where scope is defined as the wrapping
-;; elements configured in `indent-bars-treesitscope`.
+;; treesitter "scope" at point, where scope is defined as the
+;; innermost wrapping node containing point mentioned in
+;; `indent-bars-treesit-scope` for the current buffer's language.
;; For Developers:
;;
@@ -44,11 +45,12 @@
;; - If the scope boundaries have changed from the last time they
;; were saved (modulo simple marker movement), we invalidate the
;; fontification over the union of the old and new scope regions.
-;; - jit-lock is modified to apply an `indent-bars-font-lock-pending'
-;; property to modified (or context-refontified) text.
-;; - font-lock and jit-lock are configured to skip font-lock when it
-;; is not pending on the region in being fontified. See
-;; `indent-bars--fontify'.
+;; - jit-lock is modified to apply a special
+;; `indent-bars-font-lock-pending' property to modified (or
+;; contextually-refontified) text.
+;; - font-lock and jit-lock are configured to skip the core font-lock
+;; region fontification function when it is not pending in the
+;; region. See `indent-bars--fontify'.
;;
;; Note the shorthand substitutions for style related prefixes (slot
;; accessors and variables); see file-local-variables at the end:
