Skip to content

Commit

Permalink
README fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
DamienCassou committed Mar 3, 2024
1 parent abc2be2 commit 52bdd64
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.rst
Expand Up @@ -42,7 +42,7 @@ There's a large emphasis on Combobulate being both easy to use, and a natural ex

.. image:: docs/sibling-nav-jsx.gif

For instance, navigating up or down list structures with ``C-M-u`` and ``C-M-d`` is much improved. Whether you're navigating in or out of structures in Python or JSX elements in Typescript of Javascript.
For instance, navigating up or down list structures with ``C-M-u`` and ``C-M-d`` is much improved. Whether you're navigating in or out of structures in Python or JSX elements in Typescript or Javascript.

Combobulate also improves list-like navigation bound to ``C-M-n`` and ``C-M-p``, as shown above also. They now understand hierarchical code much better, and they will navigate between statements in code as well as parameters in functions or key pairs in dictionaries.

Expand Down Expand Up @@ -116,7 +116,7 @@ That is because of the *concrete syntax tree*. Place your point anywhere in your

For example: your point is on a string; but it's also in a list; which is in a dictionary; which is in an expression statement; which is in a ``for``-loop; which is in a function, and so on.

Because a *concrete syntax tree* is so exacting and so detailed, it's hard for Combobulate to infer what you want to do with the same casual insouciance of commands that don't use a syntax tree: there are simply too choices, and too many nodes.
Because a *concrete syntax tree* is so exacting and so detailed, it's hard for Combobulate to infer what you want to do with the same casual insouciance of commands that don't use a syntax tree: there are simply too many choices, and too many nodes.

You, the human, know which node you want -- but Combobulate does not necessarily know that!

Expand Down Expand Up @@ -144,8 +144,6 @@ Combobulate is not on MELPA or any other package repository, yet. For Combobulat
(Adding support for new languages is reasonably easy though!)
5. You have a git checkout of Combobulate ready.

Here's a verbose example of how to configure Combobulate in Emacs with ``use-package``. Note that if you already know how to install tree-sitter grammars, then you can leave out the code that does this in the ``:preface``.

There are two code snippets below that will help you get started. One assumes you don't know how to install and set up tree-sitter grammars, whereas the other one does.

Complete Example with Tree-Sitter Grammar Installation
Expand Down

0 comments on commit 52bdd64

Please sign in to comment.