From ebbf7d0353d9d5d3ecc42bddd50e270ba60e5243 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 24 Apr 2018 21:03:06 +0100 Subject: #1428 Show multiline hover messages, and document the new command --- doc/ale.txt | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'doc') diff --git a/doc/ale.txt b/doc/ale.txt index d5e6958b..45d7ba1a 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -654,6 +654,15 @@ supported: |ALEFindReferences| - Find references for the word under the cursor. +------------------------------------------------------------------------------- +5.4 Hovering *ale-hover* + +ALE supports "hover" information for printing brief information about symbols +at the cursor taken from LSP linters. The following commands are supported: + +|ALEHover| - Print information about the symbol at the cursor. + + =============================================================================== 6. Global Options *ale-options* @@ -1806,6 +1815,19 @@ ALEGoToDefinitionInTab *ALEGoToDefinitionInTab* A plug mapping `(ale_go_to_definition_in_tab)` is defined for this command. + +ALEHover *ALEHover* + + Print brief information about the symbol under the cursor, taken from any + available LSP linters. There may be a small non-blocking delay before + information is printed. + + NOTE: In Vim 8, long messages will be shown in a preview window, as Vim 8 + does not support showing a prompt to press enter to continue for long + messages from asynchronous callbacks. + + A plug mapping `(ale_hover)` is defined for this command. + *:ALELint* ALELint *ALELint* -- cgit v1.2.3