Mercurial > vim
changeset 36299:ed2214e79f4e draft
runtime(doc): link help-writing from write-local-help
Commit: https://github.com/vim/vim/commit/5dcee3c723b817fcd14c9abc7435e5cc4c0fc862
Author: Christian Brabandt <cb@256bit.org>
Date: Sun Oct 13 10:26:37 2024 +0200
runtime(doc): link help-writing from write-local-help
fixes: https://github.com/vim/vim/issues/15862
Signed-off-by: Christian Brabandt <cb@256bit.org>
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 13 Oct 2024 10:30:08 +0200 |
parents | 5b71917bcc99 |
children | c25bd3694f79 |
files | runtime/doc/usr_51.txt |
diffstat | 1 files changed, 3 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/runtime/doc/usr_51.txt +++ b/runtime/doc/usr_51.txt @@ -352,8 +352,9 @@ was called from a mapping defined with " DOCUMENTATION *write-local-help* It's a good idea to also write some documentation for your plugin. Especially -when its behavior can be changed by the user. See |add-local-help| for how -they are installed. +when its behavior can be changed by the user. See |help-writing| for the +syntax used by the help files and |add-local-help| for how local help files +are installed. Here is a simple example for a plugin help file, called "typecorrect.txt": >