vim-jp / issues

有志で既知のバグや要望を検討・管理し、オフィシャルへの還元をしていきます。
https://vim-jp.org/
342 stars 11 forks source link

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

Closed h-east closed 3 months ago

h-east commented 2 years ago

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

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

関連: #1172, #1321

tsuyoshicho commented 2 years ago

via Vim 8.2.5167

diff --git runtime/doc/channel.txt runtime/doc/channel.txt
index b7ae4d430..d320c46a2 100644
--- runtime/doc/channel.txt
+++ runtime/doc/channel.txt
@@ -464,7 +464,7 @@ a close callback to the channel.

 To read all normal output from a RAW channel that is available: >
    let output = ch_readraw(channel)
-To read all error output from a RAW channel that is available:: >
+To read all error output from a RAW channel that is available: >
    let output = ch_readraw(channel, {"part": "err"})
 Note that if the channel is in NL mode, ch_readraw() will only return one line
 for each call.
k-takata commented 2 years ago
diff --git a/runtime/doc/version9.txt b/runtime/doc/version9.txt
index 323829a59..9326f0b24 100644
--- a/runtime/doc/version9.txt
+++ b/runtime/doc/version9.txt
@@ -27366,7 +27366,7 @@ Files:      src/evalfunc.c, src/testdir/test_vim9_builtin.vim
 Patch 8.2.4460
 Problem:    Vim9: wrong error for defining dict function.
 Solution:   Explicitly check for trying to define a dict function.
-            (closes 9827)
+            (closes #9827)
 Files:      src/errors.h, src/userfunc.c, src/vim9compile.c,
             src/testdir/test_vim9_func.vim
k-takata commented 2 years ago

前々スレに未報告分がいくつか残っていました。

netrw関連: https://github.com/vim-jp/issues/issues/1172#issuecomment-539880533 https://github.com/vim-jp/issues/issues/1172#issuecomment-539884728

それ以外: https://github.com/vim-jp/issues/issues/1172#issuecomment-560464559 https://github.com/vim-jp/issues/issues/1172#issuecomment-561516536 (POSIXの表記ゆれはこれ以外にもあるようですが)

前スレはクローズしてしまいましたが、未報告分は残ってないですよね?

h-east commented 2 years ago

前スレはクローズしてしまいましたが、未報告分は残ってないですよね?

サラッとチェックしただけなのでもしかしたら残っているかもです。 コメントの後ろに "私が(後から編集して)コメントを足していない" && "👀 リアクションがついていない" ものは怪しいです。

h-east commented 2 years ago

あと、netrwについては報告先がBram氏ではないのとメンテナの対応が微妙(複数回先祖返りしたり...)なので、私が積極的に報告することはないです。

tsuyoshicho commented 2 years ago

via Vim 9.0.0047 with Runtime update

diff --git runtime/doc/builtin.txt runtime/doc/builtin.txt
index dc68def41..adcb8ce37 100644
--- runtime/doc/builtin.txt
+++ runtime/doc/builtin.txt
@@ -2777,7 +2777,7 @@ flattennew({list} [, {maxdepth}])         *flattennew()*
 float2nr({expr})                   *float2nr()*
        Convert {expr} to a Number by omitting the part after the
        decimal point.
-       {expr} must evaluate to a |Float| or a Number.
+       {expr} must evaluate to a |Float| or a |Number|.
        Returns 0 if {expr} is not a |Float| or a |Number|.
        When the value of {expr} is out of range for a |Number| the
        result is truncated to 0x7fffffff or -0x7fffffff (or when
tsuyoshicho commented 2 years ago

via Vim 9.0.0047 with Runtime update

diff --git runtime/doc/usr_41.txt runtime/doc/usr_41.txt
index 7f9cee487..1cf2fe289 100644
--- runtime/doc/usr_41.txt
+++ runtime/doc/usr_41.txt
@@ -139,7 +139,7 @@ FOUR KINDS OF NUMBERS
 Numbers can be decimal, hexadecimal, octal and binary.

 A hexadecimal number starts with "0x" or "0X".  For example "0x1f" is decimal
-31 and 0x1234 is decimal 4660.
+31 and "0x1234" is decimal 4660.

 An octal number starts with "0o", "0O".  "0o17" is decimal 15.
h-east commented 2 years ago

<忘れ。

diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index dc68def41..30e38c031 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -981,7 +981,7 @@ autocmd_add({acmds})                    *autocmd_add()*
            let acmd.bufnr = 5
            let acmd.cmd = 'call BufEnterFunc()'
            call autocmd_add([acmd])
-
+<
        Can also be used as a |method|: >
            GetAutocmdList()->autocmd_add()
 <
tsuyoshicho commented 2 years ago

via Vim 9.0.0057

diff --git runtime/doc/gui_x11.txt runtime/doc/gui_x11.txt
index 942037a64..14ed9f5c9 100644
--- runtime/doc/gui_x11.txt
+++ runtime/doc/gui_x11.txt
@@ -680,7 +680,7 @@ Of these three, Vim uses PRIMARY when reading and writing the "* register
 register.  Vim does not access the SECONDARY selection.

 This applies both to the GUI and the terminal version.  For non-X11 systems
-the plus and the star register both us the system clipboard.
+the plus and the star register both use the system clipboard.

 Examples: (assuming the default option values)
 - Select a URL in Visual mode in Vim.  Go to your browser and click the

追記: (2022-11-02: 既に修正されていました)

h-east commented 2 years ago

from https://github.com/vim-jp/vimdoc-ja-working/pull/1121 空白とタブの混在を修正。

diff --git a/runtime/doc/visual.txt b/runtime/doc/visual.txt
index c7163c3ff..76c1fd3e9 100644
--- a/runtime/doc/visual.txt
+++ b/runtime/doc/visual.txt
@@ -510,11 +510,11 @@ mode Vim automatically switches to Visual mode, so that the same behavior as
 in Visual mode is effective.  If you don't want this use |:xmap| or |:smap|.

 One particular edge case: >
-   :vnoremap <C-K> <Esc>
+   :vnoremap <C-K> <Esc>
 This ends Visual mode when in Visual mode, but in Select mode it does not
 work, because Select mode is restored after executing the mapped keys.  You
 need to use: >
-   :snoremap <C-K> <Esc>
+   :snoremap <C-K> <Esc>
 <
 Users will expect printable characters to replace the selected area.
 Therefore avoid mapping printable characters in Select mode.  Or use
tsuyoshicho commented 2 years ago

via Vim 9.0.0553

diff --git runtime/doc/version9.txt runtime/doc/version9.txt
index 9ec13872a..1e355e42f 100644
--- runtime/doc/version9.txt
+++ runtime/doc/version9.txt
@@ -259,7 +259,7 @@ Support for evaluating Vim expressions in a heredoc. |:let-heredoc|

 Support for fuzzy matching:
 - a string in a List of strings. |fuzzy-matching|
-- completion support for command line completion using 'wildoptions'
+- completion support for command line completion using 'wildoptions'.
 - for |:vimgrep|.

 Added support for the |Haiku| OS.
@@ -398,22 +398,22 @@ Update xdiff to version 2.33.  Update libvterm to revision 789.

 Support 'trim' for Python/Lua/Perl/Tcl/Ruby/MzScheme interface heredoc.

-Add the |t_AU| and |t_8u| termap codes for underline and undercurl.  Add the
+Add the |t_AU| and |t_8u| termcap codes for underline and undercurl.  Add the
 t_fd and t_fe termcap codes for detecting focus events.

 Support for indenting C pragmas like normal code. (|cino-P|)

-Add support for defining the syntax fold level (|:syn-foldlevel|)
+Add support for defining the syntax fold level. (|:syn-foldlevel|)

 Add support for using \<*xxx> in a string to prepend a modifier to a
-character. (|expr-quote|).
+character. (|expr-quote|)

 Add support trimming characters at the beginning or end of a string using
 |trim()|.

 Make ":verbose pwd" show the scope of the directory. |:pwd-verbose|

-Add the "0o" notation for specifying octal numbers |scriptversion-4|
+Add the "0o" notation for specifying octal numbers. |scriptversion-4|

 Support for changing to the previous tab-local and window-local directories
 using the "tcd -" and "lcd -" commands. (|:tcd-| and |:lcd-|)
@@ -428,7 +428,7 @@ Add support for executing (|:@|) a register containing line continuation.
 Lua support:
 - Call Vim functions from Lua (vim.call() and vim.fn()).
 - Convert a Lua function and a closure to a Vim funcref so that it can be
-  accessed in a Vimscript (|lua-funcref|).
+  accessed in a Vim script (|lua-funcref|).
 - Not backwards compatible: Make Lua arrays one based.
 - Add support for using table.insert() and table.remove() functions with Vim
   lists.
h-east commented 1 year ago

from https://github.com/vim-jp/vimdoc-ja-working/pull/1138 空白→タブ

diff --git a/runtime/doc/filetype.txt b/runtime/doc/filetype.txt
index d04e4ac13..370c0c3fd 100644
--- a/runtime/doc/filetype.txt
+++ b/runtime/doc/filetype.txt
@@ -570,7 +570,7 @@ used.
 For example, to set the dialect to a default of "fblite" but still allow for
 any #lang directive overrides, use the following command: >

-     let g:freebasic_lang = "fblite"
+   let g:freebasic_lang = "fblite"

 GIT COMMIT                                              *ft-gitcommit-plugin*
mityu commented 1 year ago

v0.9.0538 "null_" (null_jobnull_dict など) は前段落で predefined values と説明されている (:h null) ので、types ではなく values とすべきではないかと。

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 2a953eedf..07280b445 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -1035,7 +1035,7 @@ In Vim9 script one can use the following predefined values: >
 `true` is the same as `v:true`, `false` the same as `v:false`, `null` the same
 as `v:null`.

-While `null` has the type "special", the other "null_" types have the type
+While `null` has the type "special", the other "null_" values have the type
 indicated by their name.  Quite often a null value is handled the same as an
 empty value, but not always.  The values can be useful to clear a script-local
 variable, since they cannot be deleted with `:unlet`.  E.g.: >
tsuyoshicho commented 1 year ago

via Vim 9.0.0701

diff --git runtime/doc/userfunc.txt runtime/doc/userfunc.txt
index 806d8f76b..45cd2f4ed 100644
--- runtime/doc/userfunc.txt
+++ runtime/doc/userfunc.txt
@@ -405,7 +405,7 @@ function to abort.  `:defer` can be used to avoid that: >
      call Handle('Outfile')
    endfunc

-Note that deleting "Outfile" is scheduled before calling system(), since it
+Note that deleting "Outfile" is scheduled before calling `system()`, since it
 can be created even when `system()` fails.

 The deferred functions are called in reverse order, the last one added is
tsuyoshicho commented 1 year ago

項目の不足

via Vim 9.0.0709

diff --git runtime/doc/help.txt runtime/doc/help.txt
index db803ef80..d1af85eff 100644
--- runtime/doc/help.txt
+++ runtime/doc/help.txt
@@ -161,6 +161,8 @@ Programming language support ~
 |filetype.txt| settings done specifically for a type of file
 |quickfix.txt| commands for a quick edit-compile-fix cycle
 |ft_ada.txt|   Ada (the programming language) support
+|ft_context.txt|   Filetype plugin for ConTeXt
+|ft_mp.txt|    Filetype plugin for METAFONT and MetaPost
 |ft_ps1.txt|   Filetype plugin for Windows PowerShell
 |ft_raku.txt|  Filetype plugin for Raku
 |ft_rust.txt|  Filetype plugin for Rust
h-east commented 1 year ago

from https://github.com/vim-jp/vimdoc-ja-working/pull/1150#discussion_r992121123 行末の>がなくなっている。

diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt
index 8b3787010..f01a862ba 100644
--- a/runtime/doc/cmdline.txt
+++ b/runtime/doc/cmdline.txt
@@ -804,7 +804,7 @@ always be swapped then.

 Count and Range                        *N:*

-When giving a count before entering ":", this is translated into:
+When giving a count before entering ":", this is translated into: >
        :.,.+(count - 1)
 In words: The "count" lines at and after the cursor.  Example: To delete
 three lines: >
tsuyoshicho commented 1 year ago

via Vim 9.0.0752

typo

diff --git runtime/doc/windows.txt runtime/doc/windows.txt
index b60d44c5d..2d96b043b 100644
--- runtime/doc/windows.txt
+++ runtime/doc/windows.txt
@@ -561,9 +561,9 @@ CTRL-W =    Make all windows (almost) equally high and wide, but use
        Windows with 'winfixheight' set keep their height and windows
        with 'winfixwidth' set keep their width.
        To equalize only vertically (make window equally high) use
-       `vertical wincmd =`
+       `vertical wincmd =`.
        To equalize only horizontally (make window equally wide) use
-       `horizontal wincmd =`
+       `horizontal wincmd =`.

 :res[ize] -N                   *:res* *:resize* *CTRL-W_-*
 CTRL-W -   Decrease current window height by N (default 1).
tsuyoshicho commented 1 year ago

via Vim 9.0.0785

diff --git runtime/doc/usr_41.txt runtime/doc/usr_41.txt
index 1d5c7e58a..854f46cb8 100644
--- runtime/doc/usr_41.txt
+++ runtime/doc/usr_41.txt
@@ -687,7 +687,7 @@ search() function uses its first argument as a search pattern and the second
 one as flags.  The "W" flag means the search doesn't wrap around the end of
 the file.

-Using the  `call` command is optional in |Vim9| script.  It is required in
+Using the `call` command is optional in |Vim9| script.  It is required in
 legacy script and on the command line: >

    call search("Date: ", "W")
tsuyoshicho commented 1 year ago

via Vim 9.0.0815

diff --git runtime/doc/os_haiku.txt runtime/doc/os_haiku.txt
index 1a808625f..01c64ecf0 100644
--- runtime/doc/os_haiku.txt
+++ runtime/doc/os_haiku.txt
@@ -56,7 +56,7 @@ additionally installed over the GUI version.  Typical build commands are:
   ./configure --prefix=`finddir B_SYSTEM_NONPACKAGED_DIRECTORY` \
     --datarootdir=`finddir B_SYSTEM_NONPACKAGED_DATA_DIRECTORY` \
     --mandir=`finddir B_SYSTEM_NONPACKAGED_DIRECTORY`/documentation/man \
-    --with-tlib=ncurses \
+    --with-tlib=ncurses
   make clean
   make install
tsuyoshicho commented 1 year ago

via Vim 9.0.0815

小見出しと項目設定が不一致 from @Milly san

diff --git runtime/doc/spell.txt runtime/doc/spell.txt
index 024f26516..b5d152a36 100644
--- runtime/doc/spell.txt
+++ runtime/doc/spell.txt
@@ -1008,8 +1008,8 @@ Note: even when using "num" or "long" the number of flags available to
 compounding and prefixes is limited to about 250.

-AFFIXES
-                       *spell-PFX* *spell-SFX*
+AFFIXES                        *spell-PFX* *spell-SFX*
+
 The usual PFX (prefix) and SFX (suffix) lines are supported (see the Myspell
 documentation or the Aspell manual:
 http://aspell.net/man-html/Affix-Compression.html).
h-east commented 1 year ago

1st: 空白→タブ 2nd: タブ→空白 (タブが1つ入っているせいでhelpHeadlineでハイライトされていない)

diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 5ba2af08b..ba95f3291 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1965,7 +1965,7 @@ v:collate The current locale setting for collation order of the runtime
        command.
        See |multi-lang|.

-                                                                *v:colornames*
+                               *v:colornames*
 v:colornames    A dictionary that maps color names to hex color strings. These
        color names can be used with the |highlight-guifg|,
        |highlight-guibg|, and |highlight-guisp| parameters. Updating
@@ -3598,7 +3598,7 @@ this pending exception or command is discarded.
 For examples see |throw-catch| and |try-finally|.

-NESTING    OF TRY CONDITIONALS             *try-nesting*
+NESTING OF TRY CONDITIONALS                *try-nesting*

 Try conditionals can be nested arbitrarily.  That is, a complete try
 conditional can be put into the try block, a catch clause, or the finally
h-east commented 1 year ago

From https://github.com/vim-jp/vimdoc-ja-working/pull/1186 他の行は空白調整されたのに、置いてけぼりの行が2行ある。

diff --git a/runtime/doc/pi_tar.txt b/runtime/doc/pi_tar.txt
index d1b2959a4..37b2886d8 100644
--- a/runtime/doc/pi_tar.txt
+++ b/runtime/doc/pi_tar.txt
@@ -82,7 +82,7 @@ Copyright 2005-2017:                  *tar-copyright*
    <.vimrc> file.
             Default
    Variable          Value   Explanation
-   *g:tar_browseoptions*  "Ptf"   used to get a list of contents
+   *g:tar_browseoptions*    "Ptf"   used to get a list of contents
    *g:tar_readoptions*   "OPxf"  used to extract a file from a tarball
    *g:tar_cmd*       "tar"   the name of the tar program
    *g:tar_nomax*       0     if true, file window will not be maximized
@@ -98,7 +98,7 @@ Copyright 2005-2017:                  *tar-copyright*
                    "-"
                  Not all tar's support the "--" which is why
                  it isn't default.
-   *g:tar_writeoptions*   "uf"    used to update/replace a file
+   *g:tar_writeoptions*      "uf"    used to update/replace a file

 ==============================================================================
h-east commented 1 year ago

PRed. https://github.com/vim/vim/pull/11489

tsuyoshicho commented 1 year ago

via Vim 9.0.0828

ハイライトが消失してしまうので、入れれない...

diff --git runtime/doc/version9.txt runtime/doc/version9.txt
index 9ec13872a..5213e72e1 100644
--- runtime/doc/version9.txt
+++ runtime/doc/version9.txt
@@ -278,7 +278,7 @@ Terminal window improvements:
 - Support mouse left-right scrolling in a terminal window.

 Support for stopping profiling a Vim script: `:profile stop` and dumping the
-report to a file: `:profile dump` .  |:profile|
+report to a file: `:profile dump`.  |:profile|

 Completion improvements:
 - Argument completion support for the |:breakadd|, |:breakdel|, |:diffget|,
mityu commented 1 year ago

v9.0.827

です。

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 7c5b2b829..819e6e4d3 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -105,7 +105,7 @@ script and `:def` functions; details are below:
    `:open`
    `:s`  with only flags
    `:t`
-   `:xit`
+   `:xit`
 - Some commands, especially those used for flow control, cannot be shortened.
   E.g., `:throw` cannot be written as `:th`.  *vim9-no-shorten*
 - You cannot use curly-braces names.
@@ -746,7 +746,7 @@ continuation is used without a backslash and a line starts with a bar: >
                            *E1050*
 To make it possible for the operator at the start of the line to be
 recognized, it is required to put a colon before a range.  This example will
-add "start" and print: >
+add "start" and "print": >
    var result = start
    + print
 Like this: >
@@ -1309,7 +1309,7 @@ Closures defined in a loop will share the same context.  For example: >
 <                          *E1271*
 A closure must be compiled in the context that it is defined in, so that
 variables in that context can be found.  This mostly happens correctly, except
-when a function is marked for debugging with `breakadd` after it was compiled.
+when a function is marked for debugging with `:breakadd` after it was compiled.
 Make sure to define the breakpoint before compiling the outer function.

 The "inloop" variable will exist only once, all closures put in the list refer
@@ -1351,7 +1351,7 @@ closure: >
    }
    endfor

-Using `echowindow` is useful in a timer, the messages go into a popup and will
+Using `:echowindow` is useful in a timer, the messages go into a popup and will
 not interfere with what the user is doing when it triggers.
mityu commented 1 year ago

v9.0.827 この直前までは説明とコードの間に空行がなかったので、それとスタイルを揃える意味での空行削除です。

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 819e6e4d3..7725dcdaf 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -388,7 +388,6 @@ used: >
    echo temp  # Error!

 This is especially useful in a user command: >
-
    command -range Rename {
         var save = @a
         @a = 'some expression'
@@ -397,7 +396,6 @@ This is especially useful in a user command: >
        }

 And with autocommands: >
-
    au BufWritePre *.go {
         var save = winsaveview()
         silent! exe ':%! some formatting command'
mityu commented 1 year ago

v9.0.827 行末の余分な空白

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 7725dcdaf..998136434 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -1982,10 +1982,10 @@ Some commands have already been reserved:

 Some examples: >

-   abstract class Person 
+   abstract class Person
        static const prefix = 'xxx'
        var name: string
-       
+
        def constructor(name: string)
        this.name = name
        enddef
mityu commented 1 year ago

v9.0.827 help を見回してみた感じ、関数名として使われる funcref 以外で先頭の f が小文字表記になっているケースは少なそうだったので。 (パッチの説明の文章のところでは先頭の f が小文字の funcref 表記も結構見つかったので、しなくても良い変更かもしれないとも思いましたが、とりあえず出しておきます。)

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 998136434..80df057f5 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -265,7 +265,7 @@ Detail: this is because "Inner" will actually become a function reference to a
 function with a generated name.

 It is not possible to define a script-local function in a function.  You can
-define a local function and assign it to a script-local funcref (it must have
+define a local function and assign it to a script-local Funcref (it must have
 been declared at the script level).  It is possible to define a global
 function by using the "g:" prefix.
mityu commented 1 year ago

v9.0.827 型指定のところの > 抜け

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 80df057f5..ec6c10bfe 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -1590,7 +1590,7 @@ That is because the declaration looks like a list of numbers, thus is
 equivalent to: >
    var ll: list<number> = [1, 2, 3]
 If you do want a more permissive list you need to declare the type: >
-   var ll: list<any = [1, 2, 3]
+   var ll: list<any> = [1, 2, 3]
    ll->extend(['x'])  # OK
mityu commented 1 year ago

v9.0.827 コマンドに対してのコロン抜け

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index ec6c10bfe..2aafa9eed 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -803,7 +803,7 @@ Notes:
    echo [1, 2]
        [3, 4]
 - In some cases it is difficult for Vim to parse a command, especially when
-  commands are used as an argument to another command, such as `windo`.  In
+  commands are used as an argument to another command, such as `:windo`.  In
   those cases the line continuation with a backslash has to be used.
tsuyoshicho commented 1 year ago

via Vim 9.0.0861

余分な空白と、再フォーマット

diff --git runtime/doc/options.txt runtime/doc/options.txt
index bdc473df3..7aea6257d 100644
--- runtime/doc/options.txt
+++ runtime/doc/options.txt
@@ -7703,8 +7703,8 @@ A jump table for the options with a short description can be found at |Q_op|.
          windows.
    * -   Set highlight group to User{N}, where {N} is taken from the
          minwid field, e.g. %1*.  Restore normal highlight with %* or %0*.
-         The difference between User{N} and StatusLine  will be applied
-         to StatusLineNC for the statusline of non-current windows.
+         The difference between User{N} and StatusLine will be applied to
+         StatusLineNC for the statusline of non-current windows.
          The number N must be between 1 and 9.  See |hl-User1..9|

    When displaying a flag, Vim removes the leading comma, if any, when
h-east commented 1 year ago

@mityu https://github.com/vim-jp/issues/issues/1387#issuecomment-1307402859 https://github.com/vim-jp/issues/issues/1387#issuecomment-1310246296

コマンドに対してのコロン抜け

に関してです。 前スレの同様のコメント https://github.com/vim-jp/issues/issues/1321#issuecomment-1086585248 から "Load more…" をクリックして、6レスほど読んでいただけますか。

この件、typo PR でBram氏に質問したんですが、回答がなかったので未だにポリシーがよく分かんない状態です。 も一回聞いてみますか?

h-east commented 1 year ago

typo PRに再質問しました。

mityu commented 1 year ago

なるほど、コマンドへのリンクからコロンがなくなっていってる傾向があったと。完全につけるものだと思いこんでましたw 現状はとりあえずコマンドに対してのコロン抜けを typo とするかは Bram さんの返答次第ということですかね。了解しました。

Milly commented 1 year ago

文脈によるというお返事がありましたね。

必ずどっちかに寄せるという指針はなさそう。

https://github.com/vim/vim/pull/10620#issuecomment-1331947449

For backtick link, omit a colon? NG? :setlocal OK? setlocal

Depends on the context. If it's clear that an Ex command is typed then the colon is often left out. In between Normal mode commands it's better to show the colon, to make clear it's a different kind of command.

Milly commented 1 year ago

Via Vim 9.0.1024 + Update runtime files

Example ブロックの不足。

なお、同様の件が runtime/doc/pi_netrw.txt にもありますが netrw 案件なので放置。

M runtime/doc/textprop.txt
@@ -257,12 +257,12 @@ prop_add_list({props}, [{item}, ...])
        It is not possible to add a text property with a "text" field
        here.

-       Example:
+       Example: >
            call prop_add_list(#{type: 'MyProp', id: 2},
                    \ [[1, 4, 1, 7],
                    \  [1, 15, 1, 20],
                    \  [2, 30, 3, 30]]
-
+<
        Can also be used as a |method|: >
            GetProp()->prop_add_list([[1, 1, 1, 2], [1, 4, 1, 8]])
kuuote commented 1 year ago

Via Vim 9.0.0934 https://github.com/vim/vim/blob/3ea8a1b1296af5b0c6a163ab995aa16d49ac5f10/runtime/doc/textprop.txt#L111 https://github.com/vim/vim/blob/3ea8a1b1296af5b0c6a163ab995aa16d49ac5f10/runtime/doc/textprop.txt#L232 prop_add_listのシグニチャの一覧の方への反映が忘れられています

diff --git a/runtime/doc/textprop.txt b/runtime/doc/textprop.txt
index 086742a8f..ae7b67284 100644
--- a/runtime/doc/textprop.txt
+++ b/runtime/doc/textprop.txt
@@ -108,7 +108,7 @@ prop_type_list([{props}])       get list of property types
 Manipulating text properties:

 prop_add({lnum}, {col}, {props})   add a text property
-prop_add_list({props}, [[{lnum}, {col}, {end-lnum}, {end-col}], ...])
+prop_add_list({props}, [{item}, ...])
                    add a text property at multiple
                    positions.
 prop_clear({lnum} [, {lnum-end} [, {bufnr}]])
tsuyoshicho commented 1 year ago

via Vim 9.0.1046

diff --git runtime/doc/ft_context.txt runtime/doc/ft_context.txt
index 9b081976e..6303357ec 100644
--- runtime/doc/ft_context.txt
+++ runtime/doc/ft_context.txt
@@ -48,7 +48,7 @@ typesetting command. That must be a function that takes a path and returns the
 command as a List. For example:
 >
    def ConTeXtCustomCommand(path: string): list<string>
-     return ['mtxrun', '--script', 'context', '--nonstopmode, path]
+     return ['mtxrun', '--script', 'context', '--nonstopmode', path]
    enddef

    context.ConTeXtTypeset("%", v:none, ConTeXtCustomCommand)

こちらは例に入れている変数のミス(タグ名からすると、整理したときに見落したと思われる)

diff --git runtime/doc/ft_mp.txt runtime/doc/ft_mp.txt
index 0c6646f19..595bc0241 100644
--- runtime/doc/ft_mp.txt
+++ runtime/doc/ft_mp.txt
@@ -84,7 +84,7 @@ METAFONT buffers, and it is set to 0 by default in MetaPost buffers.
 Define additional keywords that end indented blocks. For instance, if you
 define:
 >
-   g:mp_end_tag = ['\<endfoo\>']
+   g:mp_close_tag = ['\<endfoo\>']
 <
 any line starting with `endfoo` will be de-indented compared to its previous
 line.
k-takata commented 1 year ago

https://github.com/vim-jp/issues/issues/1387#issuecomment-1304505122

-report to a file: `:profile dump` .  |:profile|
+report to a file: `:profile dump`.  |:profile|

これを直すとハイライトがなくなってしまいますね。

tsuyoshicho commented 1 year ago

あー、そうか、たしかに 対象外としてhideしておきました。

k-takata commented 1 year ago

ここまでの分、報告しました。 https://github.com/vim/vim/pull/11838

h-east commented 1 year ago

s/suffices/suffixes/

diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index 27c65dacc..ecdad6605 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -3463,7 +3463,7 @@ has a starred form (ie. eqnarray*).

 One may use "\makeatletter" in *.tex files, thereby making the use of "@" in
 commands available.  However, since the *.tex file doesn't have one of the
-following suffices: sty cls clo dtx ltx, the syntax highlighting will flag
+following suffixes: sty cls clo dtx ltx, the syntax highlighting will flag
 such use of @ as an error.  To solve this: >

    :let b:tex_stylish = 1

(2023-06-11) あっているので取り消し

h-east commented 1 year ago

ここはこう変えたほうが分かりやすいと思いました。いかがでしょう? s/"final"/:final/

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index bb4a09607..0b798a780 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -961,7 +961,7 @@ In compiled Vim9 script you get:
 Generally, you should not change the list that is iterated over.  Make a copy
 first if needed.
 When looping over a list of lists, the nested lists can be changed.  The loop
-variable is "final", it cannot be changed but what its value can be changed.
+variable is `:final`, it cannot be changed but what its value can be changed.
                            *E1306*
 The depth of loops, :for and :while loops added together, cannot exceed 10.

(2023-03-11 追記) 取り下げ

tsuyoshicho commented 1 year ago

Declarations 節も含めて、記述意図次第なところはありますね... :final コマンドとしてというより、状態が final (変更不能) を強調してる感じはあります。 変更提案としては、あってもいいとは思います(意図があってなら、その旨を説明してくれるかと)

h-east commented 1 year ago

https://github.com/vim-jp/vimdoc-ja-working/pull/1228/files#r1133052274

h-east commented 1 year ago

class, interface共実装されたので。

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 51f1f16f9..6e0ef1777 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -1749,7 +1749,7 @@ Exporting an item can be written as: >
    export interface MyClass ...
 <                          *E1043* *E1044*
 As this suggests, only constants, variables, `:def` functions and classes can
-be exported. {not implemented yet: class, interface}
+be exported.

                            *E1042*
 `:export` can only be used in Vim9 script, at the script level.
tsuyoshicho commented 1 year ago

via Vim 9.0.1413

diff --git runtime/doc/vim9class.txt runtime/doc/vim9class.txt
index 3c7722c88..e39508506 100644
--- runtime/doc/vim9class.txt
+++ runtime/doc/vim9class.txt
@@ -264,7 +264,7 @@ as the first character in the name, and it can be made public by prefixing
 <
                            *class-function*
 Class functions are also declared with "static".  They have no access to
-object members, they cannot use the "this" keyword. >
+object members, they cannot use the "this" keyword: >

    class OtherThing
       this.size: number
h-east commented 1 year ago

単なるインデントミスだと思います。 →意図したインデントらしい。

 diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index 93c56a2c6..59fde93f7 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -710,8 +710,7 @@ Don't generate a modeline disabling folding.

                              *g:html_expand_tabs*
 Default: 0 if 'tabstop' is 8, 'expandtab' is 0, 'vartabstop' is not in use,
-          and no fold column or line numbers occur in the generated HTML;
-    1 otherwise.
+and no fold column or line numbers occur in the generated HTML; 1 otherwise.
 When 1, <Tab> characters in the buffer text are replaced with an appropriate
 number of space characters, or &nbsp; references if |g:html_no_pre| is 1.
 When 0, if |g:html_no_pre| is 0 or unset, <Tab> characters in the buffer text
@@ -763,7 +762,7 @@ variable: >
 <
                            *g:html_encoding_override*
 Default: none, autoload/tohtml.vim contains default conversions for encodings
-       mentioned by name at |encoding-names|.
+mentioned by name at |encoding-names|.
 This option allows |2html.vim| to detect the correct 'fileencoding' when you
 specify an encoding with |g:html_use_encoding| which is not in the default
 list of conversions.
@@ -776,8 +775,7 @@ Detect the HTML charset "windows-1252" as the encoding "8bit-cp1252": >
 <
                             *g:html_charset_override*
 Default: none, autoload/tohtml.vim contains default conversions for encodings
-       mentioned by name at |encoding-names| and which have wide
-       browser support.
+mentioned by name at |encoding-names| and which have wide browser support.
 This option allows |2html.vim| to detect the HTML charset for any
 'fileencoding' or 'encoding' which is not detected automatically. You can also
 use it to override specific existing encoding-charset pairs. For example,
tsuyoshicho commented 1 year ago

via Vim 9.0.1442

clock_gettime() がないのを補填

diff --git runtime/doc/repeat.txt runtime/doc/repeat.txt
index 054b8705c..42ff9b1af 100644
--- runtime/doc/repeat.txt
+++ runtime/doc/repeat.txt
@@ -1149,9 +1149,9 @@ Profiling should give a good indication of where time is spent, but keep in
 mind there are various things that may clobber the results:

 - The accuracy of the time measured depends on the gettimeofday(), or
-  clock_gettime if available, system function. The accuracy ranges from 1/100
-  second to nano seconds. With clock_gettime the times are displayed in nano
-  seconds, otherwise micro seconds.  You can use `has("prof_nsec")`.
+  clock_gettime() if available, system function. The accuracy ranges from
+  1/100 second to nano seconds. With clock_gettime() the times are displayed
+  in nano seconds, otherwise micro seconds.  You can use `has("prof_nsec")`.

 - Real elapsed time is measured, if other processes are busy they may cause
   delays at unpredictable moments.  You may want to run the profiling several
h-east commented 1 year ago

from https://github.com/vim-jp/vimdoc-ja-working/pull/1262

ハイライト&concealが効くように空白を追加

diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 6f9737543..953e218d4 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -1552,7 +1552,7 @@ string to a number.

 If a type is given where it is not expected you can get *E1272* .

-If a type is incomplete you get *E1363*, e.g. when you have an object for
+If a type is incomplete you get *E1363* , e.g. when you have an object for
 which the class is not known (usually that is a null object).

 Type inference ~