diff options
| author | Neil Okamoto <neil.okamoto@gmail.com> | 2018-02-24 11:59:12 -0800 |
|---|---|---|
| committer | Bozhidar Batsov <bozhidar.batsov@gmail.com> | 2018-03-05 08:13:41 +0700 |
| commit | 8b34b901124a1ff0eb8c03aebd8c99fd2cbbb494 (patch) | |
| tree | 2fd20bd994d8031700e7fdcbfa9e118209b011dc /cider-mode.el | |
| parent | 547a8db61cf86503fd250dc7d534448b3b785292 (diff) | |
[#2199] Checkdoc fixes
Diffstat (limited to 'cider-mode.el')
| -rw-r--r-- | cider-mode.el | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/cider-mode.el b/cider-mode.el index 78d00b31..801f7e91 100644 --- a/cider-mode.el +++ b/cider-mode.el @@ -48,7 +48,7 @@ :package-version '(cider "0.10.0")) (defun cider--modeline-info () - "Return info for the `cider-mode' modeline. + "Return info for the cider mode modeline. Info contains project name and host:port endpoint." (if-let* ((current-connection (ignore-errors (cider-current-connection)))) @@ -67,16 +67,15 @@ Info contains project name and host:port endpoint." ;;;###autoload (defcustom cider-mode-line '(:eval (format " cider[%s]" (cider--modeline-info))) - "Mode line lighter for `cider-mode'. + "Mode line lighter for cider mode. The value of this variable is a mode line template as in -`mode-line-format'. See Info Node `(elisp)Mode Line Format' for -details about mode line templates. +`mode-line-format'. See Info Node `(elisp)Mode Line Format' for details +about mode line templates. -Customize this variable to change how `cider-mode' displays its -status in the mode line. The default value displays the current connection. -Set this variable to nil to disable the mode line -entirely." +Customize this variable to change how cider mode displays its status in the +mode line. The default value displays the current connection. Set this +variable to nil to disable the mode line entirely." :group 'cider :type 'sexp :risky t |