vim-haredoc

[vim] haredoc plugin
git clone https://git.torresjrjr.com/vim-haredoc.git
Log | Files | Refs | README | LICENSE

commit a2eaf062d5f67b0f12f338e015a2a77fa22fd7c2
parent 6953d4964fe957d8018d5021e78e5c5b0d97809f
Author: Byron Torres <b@torresjrjr.com>
Date:   Fri, 13 May 2022 21:19:51 +0100

doc: fix and improve

Diffstat:
Mdoc/haredoc.txt | 21+++++++++++++--------
1 file changed, 13 insertions(+), 8 deletions(-)

diff --git 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.