diff options
| author | Bozhidar Batsov <bozhidar.batsov@gmail.com> | 2016-06-23 10:12:37 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-23 10:12:37 +0300 |
| commit | 04f588e5d72c30380c5002e95be152b14970b9c5 (patch) | |
| tree | 32bfe69cb64b12003ae73a1e9911d1d749b6f0fe /doc | |
| parent | 0f8df598e7bc4a4e64aeceda8dc8111585a7ab75 (diff) | |
| parent | 1554a487c72f84c03766072c8fcad8a4629dd52c (diff) | |
Merge pull request #1785 from cskksc/feature/multiline-eldoc
Add support for multiline eldoc
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/configuration.md | 44 |
1 files changed, 28 insertions, 16 deletions
diff --git a/doc/configuration.md b/doc/configuration.md index 2fd6722b..15cb0b05 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -4,22 +4,6 @@ experience. ## Basic configuration -* Enable `eldoc` in Clojure buffers: - -```el -(add-hook 'cider-mode-hook #'eldoc-mode) -``` - - - -CIDER also would show the eldoc for the symbol at point. So in (map inc ...) -when the cursor is over inc its eldoc would be displayed. You can turn off this -behaviour by: - -```el -(setq cider-eldoc-display-for-symbol-at-point nil) -``` - * Suppress auto-enabling of `cider-mode` in `clojure-mode` buffers, when starting CIDER: @@ -140,6 +124,34 @@ More details can be found [here](https://github.com/clojure-emacs/cider/issues/9 (setq cider-filter-regexps '(".*nrepl")) ``` +## Configuring eldoc + +* Enable `eldoc` in Clojure buffers: + +```el +(add-hook 'cider-mode-hook #'eldoc-mode) +``` + + + +* CIDER also would show the eldoc for the symbol at point. So in (map inc ...) +when the cursor is over inc its eldoc would be displayed. You can turn off this +behaviour by: + +```el +(setq cider-eldoc-display-for-symbol-at-point nil) +``` + +* CIDER respects the value of `eldoc-echo-area-use-multiline-p` when +displaying documentation in the minibuffer. You can customize this variable to change +its behaviour. + +| eldoc-echo-area-use-multiline-p | Behaviour | +| ------------- | ------------- | +| `t` | Never attempt to truncate messages. Complete symbol name and function arglist or variable documentation will be displayed even if echo area must be resized to fit.| +| `nil` | Messages are always truncated to fit in a single line of display in the echo area. | +| `truncate-sym-name-if-fit` or anything non-nil | Symbol name may be truncated if it will enable the function arglist or documentation string to fit on a single line. Otherwise, behavior is just like `t` case. | + ## Overlays When you evaluate code in Clojure files, the result is displayed in the buffer |