Commit: runtime(doc): link help-writing from write-local-help

3 views
Skip to first unread message

Christian Brabandt

unread,
Oct 13, 2024, 4:30:15 AM10/13/24
to vim...@googlegroups.com
runtime(doc): link help-writing from write-local-help

Commit: https://github.com/vim/vim/commit/5dcee3c723b817fcd14c9abc7435e5cc4c0fc862
Author: Christian Brabandt <c...@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 <c...@256bit.org>

diff --git a/runtime/doc/usr_51.txt b/runtime/doc/usr_51.txt
index b0bf79224..a74795e46 100644
--- a/runtime/doc/usr_51.txt
+++ b/runtime/doc/usr_51.txt
@@ -352,8 +352,9 @@ was called from a mapping defined with ":noremap".
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": >

Reply all
Reply to author
Forward
0 new messages