summaryrefslogtreecommitdiff
path: root/doc/ale.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale.txt')
-rw-r--r--doc/ale.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 68d685d9..87d4e017 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -876,6 +876,9 @@ settings. For example: >
set ttymouse=xterm
<
+Documentation for symbols at the cursor can be retrieved using the
+|ALEDocumentation| command. This command is only available for `tsserver`.
+
-------------------------------------------------------------------------------
5.5 Symbol Search *ale-symbol-search*
@@ -2198,6 +2201,17 @@ ALE will use to search for Python executables.
===============================================================================
8. Commands/Keybinds *ale-commands*
+ALEDocumentation *ALEDocumentation*
+
+ Similar to the |ALEHover| command, retrieve documentation information for
+ the symbol at the cursor. Documentation data will always be shown in a
+ preview window, no matter how small the documentation content is.
+
+ NOTE: This command is only available for `tsserver`.
+
+ A plug mapping `<Plug>(ale_documentation)` is defined for this command.
+
+
ALEFindReferences *ALEFindReferences*
Find references in the codebase for the symbol under the cursor using the