branch: elpa/clojure-ts-mode
commit 8c025187bdb6b559d7bca83ee309d02762a5fc14
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Fix typos and grammar mistakes in documentation
---
CHANGELOG.md | 2 +-
README.md | 24 ++++++++++--------------
doc/design.md | 10 +++++-----
3 files changed, 16 insertions(+), 20 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2ed073d28c..80cec258dc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -129,7 +129,7 @@ Add support for semantic indentation (now the default)
-
[ca3914aa7aa9645ab244658f8db781cc6f95111e](https://github.com/clojure-emacs/clojure-ts-mode/commit/ca3914aa7aa9645ab244658f8db781cc6f95111e)
-
[85871fdbc831b3129dae5762e9c247d453c35e15](https://github.com/clojure-emacs/clojure-ts-mode/commit/85871fdbc831b3129dae5762e9c247d453c35e15)
-
[ff5d7e13dc53cc5da0e8139b04e02d90f61d9065](https://github.com/clojure-emacs/clojure-ts-mode/commit/ff5d7e13dc53cc5da0e8139b04e02d90f61d9065)
-- Highlight "\`quoted-symbols\` in docs strings like this."
+- Highlight "\`quoted-symbols\` in docstrings like this."
- This feature uses a nested markdown parser.
If the parser is not available this feature should be silently disabled.
-
[9af0a6b35c708309acdfeb4c0c79061b0fd4eb44](https://github.com/clojure-emacs/clojure-ts-mode/commit/9af0a6b35c708309acdfeb4c0c79061b0fd4eb44)
diff --git a/README.md b/README.md
index 3e3d99db9a..4ba1beef66 100644
--- a/README.md
+++ b/README.md
@@ -51,7 +51,7 @@ You can read more about the vision for `clojure-ts-mode`
[here](https://metaredu
The currently provided functionality should cover the needs of most Clojure
programmers, but you
can expect to encounter some bugs and missing functionality here and there.
-Those will be addressed over the time, as more and more people use
`clojure-ts-mode`.
+Those will be addressed over time, as more and more people use
`clojure-ts-mode`.
## Installation
@@ -80,11 +80,7 @@ Tree-sitter grammars automatically.
>
> That's the recommended way to install `clojure-ts-mode`.
-If you have `git` and a C compiler (`cc`) available on your system's `PATH`,
-`clojure-ts-mode` will install the
-grammars
-
-clojure-ts-mode is available on [MElPA](https://melpa.org/#/clojure-ts-mode)
and
+clojure-ts-mode is available on [MELPA](https://melpa.org/#/clojure-ts-mode)
and
[NonGNU ELPA](https://elpa.nongnu.org/nongnu/clojure-ts-mode.html).
It can be installed with:
@@ -120,12 +116,12 @@ Once installed, evaluate `clojure-ts-mode.el` and you
should be ready to go.
> [!NOTE]
>
-> `clojure-ts-mode` install the required grammars automatically, so for most
+> `clojure-ts-mode` installs the required grammars automatically, so for most
> people no manual actions will be required.
`clojure-ts-mode` makes use of the following Tree-sitter grammars:
-- The
[experimental](https://github.com/sogaiu/tree-sitter-clojure/tree/unstable-20250526)
version Clojure grammar. This version includes a few
+- The
[experimental](https://github.com/sogaiu/tree-sitter-clojure/tree/unstable-20250526)
version of the Clojure grammar. This version includes a few
improvements, which potentially will be promoted to a stable release (See
[the
discussion](https://github.com/sogaiu/tree-sitter-clojure/issues/65)). This
grammar is required for proper work of `clojure-ts-mode`.
-
[markdown-inline](https://github.com/tree-sitter-grammars/tree-sitter-markdown),
which will be used for docstrings if available and if
@@ -160,12 +156,12 @@ This installs GCC, G++, `make`, and other essential
development tools.
If `clojure-ts-mode` fails to automatically install the grammar, you have the
option to install it manually. Please, refer to the installation instructions
of
-each required grammar and make sure you're install the versions expected (see
+each required grammar and make sure you're installing the versions expected
(see
`clojure-ts-grammar-recipes` for details).
If `clojure-ts-ensure-grammars` is enabled, `clojure-ts-mode` will try to
upgrade
-the Clojure grammar if it's outdated. This might happen, when you activate
-`clojure-ts-mode` for the first time after package update. If grammar was
+the Clojure grammar if it's outdated. This might happen when you activate
+`clojure-ts-mode` for the first time after a package update. If the grammar was
previously installed, you might need to restart Emacs, because it has to reload
the grammar binary.
@@ -512,7 +508,7 @@ set. The following commands are available:
`clojure-ts-add-arity`: Add a new arity to an existing single-arity or
multi-arity function or macro. Function can be defined using `defn`, `fn` or
`defmethod` form. This command also supports functions defined inside forms
like
-`letfn`, `defprotol`, `reify`, `extend-protocol` or `proxy`.
+`letfn`, `defprotocol`, `reify`, `extend-protocol` or `proxy`.
### Default keybindings
@@ -643,7 +639,7 @@ We welcome contributions of any kind!
If you're not familiar with Tree-sitter, a good place to start is our
[design documentation](doc/design.md), which explains how Tree-sitter
works in Emacs in broad strokes and covers some of the design
-decisions we've made a long the way.
+decisions we've made along the way.
We're using [Eldev](https://github.com/emacs-eldev/eldev) as our build tool,
so you'll
have to install it. We also provide a simple [Makefile](Makefile) with targets
invoking Eldev. You
@@ -659,7 +655,7 @@ The process of releasing a new version of `clojure-ts-mode`
is documented [here]
## License
-Copyright © 2022-2025 Danny Freeman, Bozhidar Batsov and [contributors][].
+Copyright © 2022-2026 Danny Freeman, Bozhidar Batsov and [contributors][].
Distributed under the GNU General Public License; type <kbd>C-h C-c</kbd> to
view it.
diff --git a/doc/design.md b/doc/design.md
index c5616a8d25..336da541fd 100644
--- a/doc/design.md
+++ b/doc/design.md
@@ -4,7 +4,7 @@
Clojure-ts-mode is based on the tree-sitter-clojure grammar.
-If you want to contribute to clojure-ts-mode, it is recommend that you
+If you want to contribute to clojure-ts-mode, it is recommended that you
familiarize yourself with how Tree-sitter works. The official documentation is
a great place to start: <https://tree-sitter.github.io/tree-sitter/>
@@ -56,7 +56,7 @@ There are nodes to represent:
- Numbers `(num_lit)`
- Comments `(comment, dis_expr)`
- `dis_expr` is the `#_` discard expression
-- Lists `(list_list)`
+- Lists `(list_lit)`
- Vectors `(vec_lit)`
- Maps `(map_lit)`
- Sets `(set_lit)`
@@ -283,10 +283,10 @@ To find more details one can evaluate the following
expression in Emacs:
To enable the parser-based indentation engine, `clojure-ts-mode` sets the
`treesit-simple-indent-rules` with the output of
-`clojure-ts--configured-indent-rules`, and then call
`treesit-major-mode-setup`.
+`clojure-ts--configured-indent-rules`, and then calls
`treesit-major-mode-setup`.
-According to the documentation of `treesit-simple-indnet-rules` variable, its
-values is:
+According to the documentation of `treesit-simple-indent-rules` variable, its
+value is:
> A list of indent rule settings.
> Each indent rule setting should be (LANGUAGE RULE...), where LANGUAGE is
