summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Griffiths <mikey@cich.li>2015-02-28 12:16:55 +0000
committerMichael Griffiths <mikey@cich.li>2015-02-28 20:35:12 +0000
commita68fb5b0d9b1505746b6aa4e8bedf96009999413 (patch)
tree7c5441c5b48aee2ffb724b3b9873421d6f92d62a /README.md
parent7bb25903fa1f346ae71e814cbe4d17cd6a649473 (diff)
Add options for configuring completion annotations
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5f5d8989..370eb0db 100644
--- a/README.md
+++ b/README.md
@@ -498,6 +498,22 @@ from `cider-complete-at-point`, and requires no additional setup or plugins.
* Remove `cider-mode` and `cider-repl-mode` from the `ac-modes` list
+#### Completion annotations
+
+Completion candidates will be annotated by default with an abbreviation
+corresponding to their type, and (contextually) their ns. The function used to
+format the annotation can be configured by `cider-annotate-completion-function.`
+The abbreviations used are configured by `cider-completion-annotations-alist`
+and the context in which their namespace is included is configured by
+`cider-completion-annotations-include-ns.`
+
+Completion annotations can be disabled by setting
+`cider-annotate-completion-candidates` to nil.
+
+<p align="center">
+ <img src="screenshots/completion-annotations.png" width="400" />
+</p>
+
### Integration with other modes
* Enabling `CamelCase` support for editing commands(like