Mercurial > vim

comparison runtime/doc/usr_51.txt @ 36299:ed2214e79f4e draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 e1df51f68736
children 07e948b0d33b
comparison
equal deleted inserted replaced
36298:5b71917bcc99 36299:ed2214e79f4e
350 350
351 351
352 DOCUMENTATION *write-local-help* 352 DOCUMENTATION *write-local-help*
353 353
354 It's a good idea to also write some documentation for your plugin. Especially 354 It's a good idea to also write some documentation for your plugin. Especially
355 when its behavior can be changed by the user. See |add-local-help| for how 355 when its behavior can be changed by the user. See |help-writing| for the
356 they are installed. 356 syntax used by the help files and |add-local-help| for how local help files
357 are installed.
357 358
358 Here is a simple example for a plugin help file, called "typecorrect.txt": > 359 Here is a simple example for a plugin help file, called "typecorrect.txt": >
359 360
360 1 *typecorrect.txt* Plugin for correcting typing mistakes 361 1 *typecorrect.txt* Plugin for correcting typing mistakes
361 2 362 2