Skip to content

Commit e0703ff

Browse files
committed
Add a "Caveats" section the to the README
1 parent 592f708 commit e0703ff

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,22 @@ After installing the package do the following.
223223
(cider-clojure-cli-aliases . ":test:repl")))
224224
```
225225

226+
## Caveats
227+
228+
As the TreeSitter Emacs APIs are new and keep evolving there are some
229+
differences in the behavior of `clojure-ts-mode` on different Emacs versions.
230+
Here are some notable examples:
231+
232+
- On Emacs 29 the parent mode is `prog-mode`, but on Emacs 30+ it's both `prog-mode`
233+
and `clojure-mode` (this is very helpful when dealing with `derived-mode-p` checks)
234+
226235
## Frequently Asked Questions
227236

237+
### What `clojure-mode` features are currently missing?
238+
239+
As of version 0.2.x, the most obvious missing feature are the various
240+
refactoring commands in `clojure-mode`.
241+
228242
### Does `clojure-ts-mode` work with CIDER?
229243

230244
Yes! Preliminary support for `clojure-ts-mode` was released in [CIDER

0 commit comments

Comments
 (0)