haredoc.txt (1871B)
1 *haredoc.txt* *haredoc* -- documentation for the Hare programming language 2 3 This plugin integrates the haredoc command of the Hare programming language, 4 which looks up and displays documentation for Hare symbols/identifiers in your 5 source code, including symbols defined in the system's Hare standard library. 6 See haredoc(1) and hare(1). 7 8 https://docs.harelang.org/ 9 10 This plugin is not capable of resolving partial symbols (e.g. chrono::moment), 11 only full symbols that haredoc can resolve (e.g. time::chrono::moment). 12 13 This plugin appropriately uses |popup-window| and |terminal-window| to display 14 documentation. If either |+popupwin| or |+terminal| is not available, this 15 plugin falls back to a normal window. 16 17 18 MAPPINGS 19 20 *K* *haredoc-K* 21 K Show documentation for the Hare symbol under the 22 cursor in a |popup-window|. 23 Press d and u to scroll large outputs. 24 Press q or CTRL-C to close. 25 26 27 *gK* *haredoc-gK* 28 gK Show documentation for the Hare symbol under the 29 cursor in a |terminal-window|. 30 Press d and u to scroll large outputs. 31 Press q or CTRL-C once or twice to close. 32 33 COMMANDS 34 35 *:Haredoc* 36 :Haredoc {symbol} Show documentation for the given Hare symbol in a 37 |terminal-window|. 38 Press d and u to scroll large outputs. 39 Press q or CTRL-C once or twice to close. 40 41 :Haredoc . Same as the |K| command. 42 43 :Haredoc , Same as the |gK| command. 44 45 46 47 48 LICENSE 49 50 Vim License 51 52 53 vim:tw=78:ts=8:noet:ft=help:norl: