summaryrefslogtreecommitdiff
path: root/cider-common.el
diff options
context:
space:
mode:
authorChaitanya Koparkar <ckoparkar@live.in>2016-04-06 12:29:50 +0530
committerBozhidar Batsov <bozhidar.batsov@gmail.com>2016-04-06 09:59:50 +0300
commit140bb130f17ec9eb5db73133c60bc8269938e467 (patch)
treec383bf71b6d6d874f5a6c60f9bedc499e9a86302 /cider-common.el
parentd3725e9c5826871e137968af7247cb88ba97e2cc (diff)
[#1352] Documentation complies with checkdoc style
Diffstat (limited to 'cider-common.el')
-rw-r--r--cider-common.el7
1 files changed, 7 insertions, 0 deletions
diff --git a/cider-common.el b/cider-common.el
index 7bd8de51..910024e5 100644
--- a/cider-common.el
+++ b/cider-common.el
@@ -42,9 +42,16 @@ prompt if that throws an error."
:package-version '(cider . "0.9.0"))
(defun cider--should-prompt-for-symbol (&optional invert)
+ "Return the value of the variable `cider-prompt-for-symbol'.
+Optionally invert the value, if INVERT is truthy."
(if invert (not cider-prompt-for-symbol) cider-prompt-for-symbol))
(defun cider-prompt-for-symbol-function (&optional invert)
+ "Prompt for symbol if funcall `cider--should-prompt-for-symbol' is truthy.
+Otherwise attempt to use the symbol at point for the command, and only
+prompt if that throws an error.
+
+INVERT is used to invert the semantics of the function `cider--should-prompt-for-symbol'."
(if (cider--should-prompt-for-symbol invert)
#'cider-read-symbol-name
#'cider-try-symbol-at-point))