diff options
| author | Philipp Stephani <phst@google.com> | 2018-01-05 18:43:57 +0100 |
|---|---|---|
| committer | Sebastien Chapuis <sebastiencs@users.noreply.github.com> | 2018-01-05 19:40:44 +0100 |
| commit | cc66ef0f37004bdb4419b8df28827a007ad95b63 (patch) | |
| tree | 2b7e90b28570e15036a5e027bff9b50c6120971a /lsp-ui.el | |
| parent | a30139eab6fb19173b9e1fe5ef3ae8b75de5a5a5 (diff) | |
Give ‘lsp-ui-mode’ a docstring that describes what the mode function does
Diffstat (limited to 'lsp-ui.el')
| -rw-r--r-- | lsp-ui.el | 7 |
1 files changed, 6 insertions, 1 deletions
@@ -67,7 +67,12 @@ If the path is not in the workspace, it returns the original PATH." (defvar lsp-ui-mode-map (make-sparse-keymap)) (define-minor-mode lsp-ui-mode - "Minor mode that contains a series of useful UI integrations for lsp-mode." + "Toggle language server UI mode on or off. +‘lsp-ui-mode’ is a minor mode that contains a series of useful UI +integrations for ‘lsp-mode’. With a prefix argument ARG, enable +language server UI mode if ARG is positive, and disable it +otherwise. If called from Lisp, enable the mode if ARG is +omitted or nil, and toggle it if ARG is ‘toggle’." :init-value nil :group lsp-ui (lsp-ui--toggle lsp-ui-mode)) |