auto-completion: manual help tooltip and minor fix
New value `manual` for auto-completion-enable-help-tooltip enables the user to display help tooltip on-demand. Other values remain the same: nil for no tooltip at all, t (or any non-nil non-manual value) for automatic tooltip. Minor fix: call `company-quickhelp-mode` just once, because it's a global minor-mode.
This commit is contained in:
parent
d202ead5fa
commit
6d454a2313
|
@ -102,7 +102,8 @@ the popup, set the variable =auto-completion-enable-snippets-in-popup= to =t=.
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
** Tooltips
|
** Tooltips
|
||||||
To enable docstring tooltips set =auto-completion-enable-help-tooltip= to =t=
|
To enable automatic docstring tooltips set =auto-completion-enable-help-tooltip=
|
||||||
|
to =t=.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(setq-default dotspacemacs-configuration-layers
|
(setq-default dotspacemacs-configuration-layers
|
||||||
|
@ -110,6 +111,15 @@ To enable docstring tooltips set =auto-completion-enable-help-tooltip= to =t=
|
||||||
auto-completion-enable-help-tooltip t)))
|
auto-completion-enable-help-tooltip t)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
To enable manual non-automatic invocation of docstring tooltips, set it to
|
||||||
|
=manual=. The tooltip can be invoked manually by pressing ~M-h~.
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(setq-default dotspacemacs-configuration-layers
|
||||||
|
'((auto-completion :variables
|
||||||
|
auto-completion-enable-help-tooltip 'manual)))
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
** Sort results by usage
|
** Sort results by usage
|
||||||
To enable sorting auto-completion results by their usage frequency set
|
To enable sorting auto-completion results by their usage frequency set
|
||||||
=auto-completion-enable-sort-by-usage= to =t=.
|
=auto-completion-enable-sort-by-usage= to =t=.
|
||||||
|
@ -197,11 +207,12 @@ For nicer-looking faces, try adding the following to `custom-set-faces` in your
|
||||||
* Key Bindings
|
* Key Bindings
|
||||||
** Company
|
** Company
|
||||||
|
|
||||||
| Key Binding | Description |
|
| Key Binding | Description |
|
||||||
|-------------+--------------------------------------------------------------------------|
|
|-------------+------------------------------------------------------------------------------------------------------|
|
||||||
| ~C-d~ | open minibuffer with documentation of thing at point in company dropdown |
|
| ~C-d~ | open minibuffer with documentation of thing at point in company dropdown |
|
||||||
| ~C-/~ | show candidates in Helm (for fuzzy searching) |
|
| ~C-/~ | show candidates in Helm (for fuzzy searching) |
|
||||||
| ~C-M-/~ | filter the company dropdown menu |
|
| ~C-M-/~ | filter the company dropdown menu |
|
||||||
|
| ~M-h~ | show current candidate's documentation in a tooltip (requires =auto-completion-enable-help-tooltip=) |
|
||||||
|
|
||||||
Vim Style:
|
Vim Style:
|
||||||
|
|
||||||
|
|
|
@ -37,7 +37,9 @@ selection.")
|
||||||
"If non nil suggestions are sorted by how often they are used.")
|
"If non nil suggestions are sorted by how often they are used.")
|
||||||
|
|
||||||
(defvar auto-completion-enable-help-tooltip nil
|
(defvar auto-completion-enable-help-tooltip nil
|
||||||
"If non nil the docstring appears in a tooltip.")
|
"If non nil the docstring appears in a tooltip.
|
||||||
|
If set to `manual', help tooltip appears only when invoked
|
||||||
|
manually.")
|
||||||
|
|
||||||
(defvar company-mode-completion-cancel-keywords
|
(defvar company-mode-completion-cancel-keywords
|
||||||
'("do"
|
'("do"
|
||||||
|
|
|
@ -114,12 +114,14 @@
|
||||||
|
|
||||||
(defun auto-completion/init-company-quickhelp ()
|
(defun auto-completion/init-company-quickhelp ()
|
||||||
(use-package company-quickhelp
|
(use-package company-quickhelp
|
||||||
:defer t
|
:commands company-quickhelp-manual-begin
|
||||||
:init
|
:init
|
||||||
(spacemacs|do-after-display-system-init
|
(spacemacs|do-after-display-system-init
|
||||||
(add-hook 'company-mode-hook 'company-quickhelp-mode)
|
|
||||||
(with-eval-after-load 'company
|
(with-eval-after-load 'company
|
||||||
(setq company-frontends (delq 'company-echo-metadata-frontend company-frontends))))))
|
(setq company-frontends (delq 'company-echo-metadata-frontend company-frontends))
|
||||||
|
(define-key company-active-map (kbd "M-h") #'company-quickhelp-manual-begin)
|
||||||
|
(unless (eq auto-completion-enable-help-tooltip 'manual)
|
||||||
|
(company-quickhelp-mode))))))
|
||||||
|
|
||||||
(defun auto-completion/init-helm-c-yasnippet ()
|
(defun auto-completion/init-helm-c-yasnippet ()
|
||||||
(use-package helm-c-yasnippet
|
(use-package helm-c-yasnippet
|
||||||
|
|
Loading…
Reference in New Issue