Skip to content

Commit 118c197

Browse files
committed
Add a note about docstring indentation to the readme
1 parent deb35d9 commit 118c197

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ well.
9191

9292
## Configuration
9393

94+
In the spirit of Emacs, pretty much everything you can think of in `clojure-mode` is configurable.
95+
9496
To see a list of available configuration options do `M-x customize-group RET clojure`.
9597

9698
### Indentation options
@@ -99,6 +101,13 @@ The default indentation rules in `clojure-mode` are derived from the
99101
[community Clojure Style Guide](https://github.com/bbatsov/clojure-style-guide).
100102
Please, refer to the guide for the general Clojure indentation rules.
101103

104+
#### Indentation of docstrings
105+
106+
By default multi-line docstrings are indented with 2 spaces, as this is a
107+
somewhat common standard in the Clojure community. You can however adjust this
108+
by modifying `clojure-docstring-fill-prefix-width`. Set it to 0 if you don't
109+
want multi-line docstrings to be indented at all (which is pretty common in most lisps).
110+
102111
#### Indentation of function forms
103112

104113
The indentation of function forms is configured by the variable

0 commit comments

Comments
 (0)