branch: elpa/clojure-mode
commit b91d2d487eaf0cbe403d7343299e7f3d0f024064
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Document clojure-toplevel-inside-comment-form in README
---
README.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/README.md b/README.md
index b760d4ad6b..a36d1e2212 100644
--- a/README.md
+++ b/README.md
@@ -302,6 +302,17 @@ functions (e.g. `comment-region`) would use `;` by default
instead of `;;`.
> style guide to understand better the semantics of the different comment
> levels
> and why `clojure-mode` treats them differently by default.
+#### Top-level forms inside `(comment ...)`
+
+By default, `beginning-of-defun` and related navigation treat the entire
+`(comment ...)` form as one top-level form. If you'd prefer the forms *inside*
+`comment` to be treated as top-level (e.g. for evaluation with CIDER), you
+can enable this:
+
+```el
+(setq clojure-toplevel-inside-comment-form t)
+```
+
### Vertical alignment
You can vertically align sexps with `C-c C-a`. For instance, typing
