branch: externals/indent-bars commit 7c7a7a7a103ef13f01ae388a1116dde3917e8b10 Author: JD Smith <93749+jdtsm...@users.noreply.github.com> Commit: JD Smith <93749+jdtsm...@users.noreply.github.com>
improve commentary --- indent-bars.el | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/indent-bars.el b/indent-bars.el index 0767f487d0..f8bfcdf1f9 100644 --- a/indent-bars.el +++ b/indent-bars.el @@ -24,14 +24,15 @@ ;;; Commentary: -;; indent-bars highlights indentation with configurable vertical bars, -;; using stipples. The color and appearance (weight, pattern, -;; position within the character, zigzag, etc.) are all configurable. -;; Options include depth-varying colors and highlighting the -;; indentation depth of the current line. Bars span blank lines, by -;; default. indent-bars works in any mode using fixed tab or -;; space-based indentation. In the terminal (or on request) it uses -;; vertical bar characters instead of stipple patterns. +;; indent-bars highlights indentation with configurable vertical +;; graphical bars, using stipples. The color and appearance (weight, +;; pattern, position within the character, zigzag, etc.) are all +;; configurable. Options include depth-varying colors and +;; highlighting the indentation depth of the current line. Bars span +;; blank lines, by default. indent-bars works in any mode using fixed +;; tab or space-based indentation. In the terminal (or on request) it +;; uses vertical bar characters instead of stipple patterns. Optional +;; treesitter support is also available; see indent-bars-ts.el. ;; For Developers: ;; @@ -42,12 +43,12 @@ ;; pattern, etc.) into a single struct, operating on one such ;; "current" style struct at a time. ;; -;; 2. Provide convenience functions for replicating "alternative" +;; 2. Provide convenience functions for duplicate "alternative" ;; custom style variables the user can configure; see ;; `indent-bars--style'. These variables can "inherit" nil or ;; omitted plist variables from their parent var. ;; -;; Note the shorthand substitution for style related slot; +;; Note the shorthand substitution for style related slots; ;; see file-local-variables at the end: ;; ;; ibs/ => indent-bars-style-