Skip to content

Commit b74c0a1

Browse files
authored
Merge pull request #2045 from h-east/update-helphelp
Update helphelp.{txt,jax}
2 parents c9ab276 + 9d753d7 commit b74c0a1

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

doc/helphelp.jax

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*helphelp.txt* For Vim バージョン 9.1. Last change: 2025 Apr 08
1+
*helphelp.txt* For Vim バージョン 9.1. Last change: 2025 Apr 21
22

33

44
VIMリファレンスマニュアル by Bram Moolenaar
@@ -378,6 +378,10 @@ Tip: `/` コマンドで検索するパターンを挿入した後、<CR> では
378378
書式で書かれていると便利です。あなたが新しいヘルプファイルを書くときは、既存の
379379
ファイルをコピーしてそれをテンプレートとして使用するといいでしょう。
380380

381+
Vim のヘルプファイルでは通常、文の後に 2 つのスペースを使用します (等幅フォン
382+
トを使用して記述されており、これが 70 年代 / 80 年代に好まれたスタイルであった
383+
ため)。こちらで説明されています: https://english.stackexchange.com/a/2602
384+
381385
ヘルプファイルの 1 行目は次のように書きます:
382386

383387
*plugin_name.txt* {プラグインの短い説明}

en/helphelp.txt

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*helphelp.txt* For Vim version 9.1. Last change: 2025 Apr 08
1+
*helphelp.txt* For Vim version 9.1. Last change: 2025 Apr 21
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -383,6 +383,10 @@ standard Vim help files, except for the first line. If you are writing a new
383383
help file it's best to copy one of the existing files and use it as a
384384
template.
385385

386+
Vim help files generally use 2 spaces after a sentence (since they are written
387+
using a fixed-width font and that was the prefered style in the 70s/80s), like
388+
what is described here: https://english.stackexchange.com/a/2602
389+
386390
The first line in a help file should have the following format:
387391

388392
*plugin_name.txt* {short description of the plugin}

0 commit comments

Comments
 (0)