diff options
| author | Byron Torres <b@torresjrjr.com> | 2022-05-13 21:19:51 +0100 |
|---|---|---|
| committer | Byron Torres <b@torresjrjr.com> | 2022-05-13 21:19:51 +0100 |
| commit | a2eaf062d5f67b0f12f338e015a2a77fa22fd7c2 (patch) | |
| tree | 29f75d2b2e86f0d3384695336f6fb8332b5d4a19 | |
| parent | mention license and mirrors (diff) | |
| download | vim-haredoc-a2eaf062d5f67b0f12f338e015a2a77fa22fd7c2.tar.gz | |
doc: fix and improve
| -rw-r--r-- | doc/haredoc.txt | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/haredoc.txt b/doc/haredoc.txt index dff39d8..f33a755 100644 --- a/doc/haredoc.txt +++ b/doc/haredoc.txt @@ -1,11 +1,15 @@ -*haredoc.txt* *haredoc* haredoc in vim +*haredoc.txt* *haredoc* haredoc in vim This plugin integrates the haredoc command of the Hare programming language, -which looks up and displays documentation for the Hare standard library and -your own Hare modules. See haredoc(1). +which looks up and displays documentation for Hare symbols/identifiers in your +source code, including symbols defined in the system's Hare standard library. +See haredoc(1) and hare(1). https://docs.harelang.org/ +This plugin is not capable of resolving partial symbols (e.g. chrono::moment), +only full symbols that haredoc can resolve (e.g. time::chrono::moment). + This plugin appropriately uses |popup-window| and |terminal-window| to display documentation. If either |+popupwin| or |+terminal| is not available, this plugin falls back to a normal window. @@ -14,16 +18,17 @@ plugin falls back to a normal window. MAPPINGS *K* *haredoc-K* -K Show documentation in a |popup-window| for the - symbol under the cursor +K Show documentation for the Hare symbol under the + cursor in a |popup-window|. Press q or CTRL-C to + close. COMMANDS *:Haredoc* - -:Haredoc {symbol} Show documentation in a |terminal-window| for the - symbol under the cursor. +:Haredoc {symbol} Show documentation for the given Hare symbol in a + |terminal-window|. Press q or CTRL-C once or twice to + close. :Haredoc . Same as the |K| command. |