本家helpのtypo報告スレ (Vim 9.0)

[h-east]

本家help(runtime/doc/*.txt)のtypoを報告するスレです。 その都度vim_devに報告するとウザいのである程度溜まってから報告します。

typo発見時のVimバージョン(9.0.xxxx)も添えていただけると助かります。

関連: #1172, #1321

[h-east]

From https://github.com/vim-jp/vimdoc-ja-working/pull/1569#pullrequestreview-2108137729 Regression.

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 6849bc3ca..7c36a6e68 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1915,7 +1915,7 @@ A jump table for the options with a short description can be found at |Q_op|.
            feature}
    A template for a comment.  The "%s" in the value is replaced with the
    comment text, and should be padded with a space when possible.
-   Currently used to add markers for folding, see |fold-marker| also
+   Currently used to add markers for folding, see |fold-marker|.  Also
    commonly used by commenting plugins (e.g. |comment-install|).

            *'compatible'* *'cp'* *'nocompatible'* *'nocp'*

[h-east]

From https://github.com/vim-jp/vimdoc-ja-working/pull/1574 タブずれ

diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt
index 0f0b42a64..4074b6060 100644
--- a/runtime/doc/terminal.txt
+++ b/runtime/doc/terminal.txt
@@ -1440,12 +1440,12 @@ You can usually shorten `:Evaluate` to `:Ev`.

 Navigating stack frames ~
                *termdebug-frames* *:Frame* *:Up* *:Down*
- :Frame [frame]    select frame [frame], which is a frame number,
+ :Frame [frame]        select frame [frame], which is a frame number,
            address, or function name (default: current frame)
  :Up [count]       go up [count] frames (default: 1; the frame that
            called the current)
  +         same (see |termdebug_map_plus| to disable)
- :Down [count] go down [count] frames (default: 1; the frame called
+ :Down [count]     go down [count] frames (default: 1; the frame called
            by the current)
  -         same (see |termdebug_map_minus| to disable)

---

既に修正されている。

[h-east]

From https://github.com/vim-jp/vimdoc-ja-working/pull/1576

. 抜け。

diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index 7ec47bd83..e9a810904 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -5685,9 +5685,9 @@ PmenuSbar Popup menu: Scrollbar.
                            *hl-PmenuThumb*
 PmenuThumb Popup menu: Thumb of the scrollbar.
                            *hl-PmenuMatch*
-PmenuMatch Popup menu: Matched text in normal item
+PmenuMatch Popup menu: Matched text in normal item.
                            *hl-PmenuMatchSel*
-PmenuMatchSel  Popup menu: Matched text in selected item
+PmenuMatchSel  Popup menu: Matched text in selected item.
                            *hl-PopupNotification*
 PopupNotification
        Popup window created with |popup_notification()|.  If not

[h-east]

From https://github.com/vim-jp/vimdoc-ja-working/pull/1577

• Return Type: ～ と次の関数のhelpタグラベルの行の間に空行がない。(2カ所)
• helpタグラベル行頭の < 削除忘れ。(1か所)

diff --git a/runtime/doc/testing.txt b/runtime/doc/testing.txt
index f1a7e60bb..7bc6f8a77 100644
--- a/runtime/doc/testing.txt
+++ b/runtime/doc/testing.txt
@@ -499,6 +499,7 @@ assert_beeps({cmd})                 *assert_beeps()*
            GetCmd()->assert_beeps()
 <
        Return type: |Number|
+
                            *assert_equal()*
 assert_equal({expected}, {actual} [, {msg}])
        When {expected} and {actual} are not equal an error message is
@@ -522,7 +523,7 @@ assert_equal({expected}, {actual} [, {msg}])
 <
        Return type: |Number|

-<                          *assert_equalfile()*
+                           *assert_equalfile()*
 assert_equalfile({fname-one}, {fname-two} [, {msg}])
        When the files {fname-one} and {fname-two} do not contain
        exactly the same text an error message is added to |v:errors|.
@@ -550,6 +551,7 @@ assert_exception({error} [, {msg}])         *assert_exception()*
            endtry
 <
        Return type: |Number|
+
                            *assert_fails()*
 assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
        Run {cmd} and add an error message to |v:errors| if it does

[h-east]

From https://github.com/vim-jp/vimdoc-ja-working/pull/1576#pullrequestreview-2117873050

diff --git a/runtime/syntax/generator/vim.vim.base b/runtime/syntax/generator/vim.vim.base
index 743c0cd1e..70d3ed2c2 100644
--- a/runtime/syntax/generator/vim.vim.base
+++ b/runtime/syntax/generator/vim.vim.base
@@ -862,12 +862,12 @@ endif
 " Allows users to specify the type of embedded script highlighting
 " they want:  (perl/python/ruby/tcl support)
 "   g:vimsyn_embed == 0   : don't embed any scripts
-"   g:vimsyn_embed =~# 'l' : embed lua      (but only if vim supports it)
-"   g:vimsyn_embed =~# 'm' : embed mzscheme (but only if vim supports it)
-"   g:vimsyn_embed =~# 'p' : embed perl     (but only if vim supports it)
-"   g:vimsyn_embed =~# 'P' : embed python   (but only if vim supports it)
-"   g:vimsyn_embed =~# 'r' : embed ruby     (but only if vim supports it)
-"   g:vimsyn_embed =~# 't' : embed tcl      (but only if vim supports it)
+"   g:vimsyn_embed =~# 'l' : embed Lua      (but only if vim supports it)
+"   g:vimsyn_embed =~# 'm' : embed MzScheme (but only if vim supports it)
+"   g:vimsyn_embed =~# 'p' : embed Perl     (but only if vim supports it)
+"   g:vimsyn_embed =~# 'P' : embed Python   (but only if vim supports it)
+"   g:vimsyn_embed =~# 'r' : embed Ruby     (but only if vim supports it)
+"   g:vimsyn_embed =~# 't' : embed Tcl      (but only if vim supports it)
 if !exists("g:vimsyn_embed")
  let g:vimsyn_embed= "lmpPr"
 endif

[h-east]

From https://github.com/vim-jp/vimdoc-ja-working/pull/1574 リンクにしておこう。

diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt
index f509ea979..a2d649ef4 100644
--- a/runtime/doc/terminal.txt
+++ b/runtime/doc/terminal.txt
@@ -648,7 +648,7 @@ term_getjob({buf})                  *term_getjob()*
        Get the Job associated with terminal window {buf}.
        {buf} is used as with |term_getsize()|.
        Returns |v:null| when there is no job. In Vim9 script, return
-       null_job when there is no job.
+       |null_job| when there is no job.

        Can also be used as a |method|: >
            GetBufnr()->term_getjob()

[mityu]

真上の test_void() の説明と食い違うのと、あと実際

echo typename(test_unknown())  "=> unknown
echo typename(test_void()) "=> void

となるので、戻り値の型は unknown じゃなくて void が正解じゃないかと。

diff --git a/runtime/doc/testing.txt b/runtime/doc/testing.txt
index f1a7e60bb..b0cf4658e 100644
--- a/runtime/doc/testing.txt
+++ b/runtime/doc/testing.txt
@@ -483,7 +483,7 @@ test_unknown()                      *test_unknown()*
 test_void()                        *test_void()*
        Return a value with void type. Only useful for testing.

-       Return type: unknown
+       Return type: void

 ==============================================================================
 3. Assert functions                *assert-functions-details*

[h-east]

Typo.

diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index ff7078ea8..a2747876b 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -3591,7 +3591,7 @@ get({dict}, {key} [, {default}])
        Preferably used as a |method|: >
            mydict->get(key)
 <
-       Return type: any, depending on {list}
+       Return type: any, depending on {dict}

 get({func}, {what})
        Get item {what} from Funcref {func}.  Possible values for
@@ -3755,7 +3755,7 @@ getcellwidths()                       *getcellwidths()*
        by |setcellwidths()|.  The format is equal to the argument of
        |setcellwidths()|.  If no character ranges have their cell
        widths overridden, an empty List is returned.
-<
+
        Return type: list<any>

[mityu]

スペースをハードタブに変換

diff --git a/runtime/doc/version9.txt b/runtime/doc/version9.txt
index 28dd7a3ad..71e95554e 100644
--- a/runtime/doc/version9.txt
+++ b/runtime/doc/version9.txt
@@ -41597,7 +41597,7 @@ Highlighting: ~

 |hl-MsgArea|       highlighting of the Command-line and messages area
 |hl-PmenuMatch|        Popup menu: highlighting of matched text
-|hl-PmenuMatchSel|         Popup menu: highlighting of matched text in selected
+|hl-PmenuMatchSel| Popup menu: highlighting of matched text in selected
            line

 Commands: ~

[h-east]

ここまでをPRed. https://github.com/vim/vim/pull/15034 → merged

[h-east]

キリが良いので新スレ立てます。