diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-06-25 09:17:47 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-25 09:17:47 -0700 |
| commit | 5ceb2238d3685255cd517ca87fd7edae9ed88811 (patch) | |
| tree | 5972cd240cb18d50a7d56b3b5e0c1019c947e07a /runtime/doc/helphelp.txt | |
| parent | e59cf3b3a9ee0f9e9b4d2e01059dbdf185eb5685 (diff) | |
| parent | 49a7585981cdf7403e76a614558e602a98e64301 (diff) | |
| download | rneovim-5ceb2238d3685255cd517ca87fd7edae9ed88811.tar.gz rneovim-5ceb2238d3685255cd517ca87fd7edae9ed88811.tar.bz2 rneovim-5ceb2238d3685255cd517ca87fd7edae9ed88811.zip | |
Merge #24116 from justinmk/doc
Diffstat (limited to 'runtime/doc/helphelp.txt')
| -rw-r--r-- | runtime/doc/helphelp.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt index ca26332017..80b237160f 100644 --- a/runtime/doc/helphelp.txt +++ b/runtime/doc/helphelp.txt @@ -317,9 +317,9 @@ standard Vim help files, except for the first line. If you are writing a new help file it's best to copy one of the existing files and use it as a template. -The first line in a help file should have the following format: +The first line in a help file should have the following format: > -*plugin_name.txt* {short description of the plugin} + *plugin_name.txt* {short description of the plugin} The first field is a help tag where ":help plugin_name" will jump to. The remainder of the line, after a Tab, describes the plugin purpose in a short @@ -383,8 +383,8 @@ The following are highlighted differently in a Vim help file: The word "Note", "Notes" and similar automagically receive distinctive highlighting. So do these: - *Todo something to do - *Error something wrong + Todo something to do + Error something wrong You can find the details in $VIMRUNTIME/syntax/help.vim |