emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/indent-bars 3d55fd643d 330/431: Update README.md


From: ELPA Syncer
Subject: [elpa] externals/indent-bars 3d55fd643d 330/431: Update README.md
Date: Mon, 16 Sep 2024 12:59:47 -0400 (EDT)

branch: externals/indent-bars
commit 3d55fd643d968960099e0a0f2246628d1f5ad8fe
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: GitHub <noreply@github.com>

    Update README.md
---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 104250c7aa..07ae124c5c 100644
--- a/README.md
+++ b/README.md
@@ -238,8 +238,8 @@ Experiment with these to see what you prefer.
 `indent-bars` can optionally use tree-sitter in supported files to enable 
several features:
 
 1. **Scope Focus**: The current tree-sitter scope can be _focused_, with 
out-of-scope bars de-emphasized in their display (or actually, styled however 
you want).  This can be configured by [specifying matching 
"scope"](#configuring-tree-sitter) node types (e.g. functions, blocks, etc.) 
for each language of interest.  The innermost node (covering sufficient lines) 
will then be rendered using the normal bar color and style.  Bars which are 
_out-of-scope_ have alternative styling applied.
-1. **Blank Line Display**: It can be nice to omit the display of bars on blank 
lines at the top structural level (e.g. in a _module_).  Tree-sitter can help 
`indent-bars` identify those lines.
-1. **Wrap Detection**: It can be useful to prevent drawing excess bars in 
wrapped entities like argument lists, literal dictionaries, or other 
heirarchical multi-line structures.  Tree-sitter can help detect these and 
inhibit unwanted bars (see also `indent-bars-no-descend-string/list`, which do 
not require tree-sitter).
+1. **Selective Blank Line Display**: By default, `indent-bars` displays bars 
on blank lines (though this can be [configured](#bar-setup-and-location)), so 
that they remain continuous.  It can be nice to omit the display of blank lines 
bars at the top structural level (e.g. in a _module_), to make divisions 
between top-level constructs more visible.  Tree-sitter can help `indent-bars` 
identify those lines.
+1. **Wrap Detection**: It can be useful to prevent excess bars inside wrapped 
entities which move indent to "line things up." These include things like 
argument lists, literal dictionaries, or other heirarchical multi-line 
structures.  Tree-sitter can help detect these and inhibit unwanted bars (but 
[see also](#bar-setup-and-location) `indent-bars-no-descend-string/list`, which 
do not require tree-sitter).
 
 > [!NOTE]
 > `indent-bars`' tree-sitter capabilities require Emacs 29 or later built with 
 > tree-sitter support, and the appropriate tree-sitter grammars installed for 
 > your languages of interest.  Additional node type configuration by language 
 > required; see below.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]