vim-jp / issues

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

本家helpのtypo報告スレ (Vim 8.1) #1172

Open h-east opened 6 years ago

h-east commented 6 years ago

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

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

関連: #1032

h-east commented 6 years ago

https://github.com/vim-jp/vimdoc-ja-working/pull/231#issuecomment-395976710

diff --git a/runtime/doc/os_beos.txt b/runtime/doc/os_beos.txt
index 4639566e4..148f5fe0e 100644
--- a/runtime/doc/os_beos.txt
+++ b/runtime/doc/os_beos.txt
@@ -144,7 +144,7 @@ The default value for $VIM is set at compile time and can be determined with >
   :version

 The normal value is /boot/home/config/share/vim.  If you don't like it you can
-set the Vim environment variable to override this, or set 'helpfile' in your
+set the VIM environment variable to override this, or set 'helpfile' in your
 .vimrc: >

   :if version >= 500
uakms commented 6 years ago

(8.1.0053 です) 縦棒は不要ではないでしょうか。

diff --git a/runtime/doc/ft_ada.txt b/runtime/doc/ft_ada.txt
index b446faf17..1d08bbb07 100644
--- a/runtime/doc/ft_ada.txt
+++ b/runtime/doc/ft_ada.txt
@@ -249,7 +249,7 @@ g:decada.Make_Command       string
                External command used for |g:decada.Make()| (|'makeprg'|).

                                                       *g:decada.Error_Format*
-g:decada.Error_Format| string
+g:decada.Error_Format  string
                Error format (|'errorformat'|).

 ==============================================================================
h-east commented 6 years ago

前スレの未報告分も含めてvim_devに報告しました。 https://groups.google.com/d/topic/vim_dev/TYM_T174lg8/discussion 但し、chipさんのは含んでいません。

h-east commented 6 years ago
diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt
index 7c2547f10..02713d8e3 100644
--- a/runtime/doc/insert.txt
+++ b/runtime/doc/insert.txt
@@ -1535,7 +1535,7 @@ phpFunctions.

 If you wish non-filetype syntax items to also be included, you can use a
 regular expression syntax (added in version 13.0 of
-autoload\syntaxcomplete.vim) to add items.  Looking at the output from
+autoload/syntaxcomplete.vim) to add items.  Looking at the output from
 ":syntax list" while editing a PHP file I can see some of these entries: >
     htmlArg,htmlTag,htmlTagName,javaScriptStatement,javaScriptGlobalObjects

Fixed.

h-east commented 6 years ago

80カラム超え

diff --git a/runtime/doc/editing.txt b/runtime/doc/editing.txt
index e553d467d..4e974579f 100644
--- a/runtime/doc/editing.txt
+++ b/runtime/doc/editing.txt
@@ -901,8 +901,8 @@ flag is used for the ":substitute" command to avoid an error for files where
 Note: When the 'write' option is off, you are not able to write any file.

                            *:w* *:write*
-                       *E502* *E503* *E504* *E505*
-                       *E512* *E514* *E667* *E796* *E949*
+                   *E502* *E503* *E504* *E505*
+                   *E512* *E514* *E667* *E796* *E949*
 :w[rite] [++opt]   Write the whole buffer to the current file.  This is
            the normal way to save changes to a file.  It fails
            when the 'readonly' option is set or when there is

Fixed.

h-east commented 6 years ago

https://github.com/vim-jp/issues/issues/1172#issuecomment-397888699 で送った分、8.1.0078の後のRuntimeファイル更新patch で反映されました。

mnishz commented 6 years ago

Ver. 8.1.0091です。 +eval タグのリンク貼り忘れと思われます。 vim-jp/vimdoc-ja-working#267

diff --git a/runtime/doc/repeat.txt b/runtime/doc/repeat.txt
index 62464780e..ff1d68d38 100644
--- a/runtime/doc/repeat.txt
+++ b/runtime/doc/repeat.txt
@@ -265,7 +265,7 @@ For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
            loaded during initialization, see |load-plugins|.

            Also see |pack-add|.
-           {only available when compiled with +eval}
+           {only available when compiled with |+eval|}

                        *:packl* *:packloadall*
 :packl[oadall][!]  Load all packages in the "start" directory under each
@@ -289,7 +289,7 @@ For writing a Vim script, see chapter 41 of the user manual |usr_41.txt|.
            An error only causes sourcing the script where it
            happens to be aborted, further plugins will be loaded.
            See |packages|.
-           {only available when compiled with +eval}
+           {only available when compiled with |+eval|}

 :scripte[ncoding] [encoding]       *:scripte* *:scriptencoding* *E167*
            Specify the character encoding used in the script.

Fixed.

mnishz commented 6 years ago

Ver. 8.1.0091です。 "earch" -> "each" と思われます。

diff --git a/runtime/doc/filetype.txt b/runtime/doc/filetype.txt
index f41dc703e..0c33845f5 100644
--- a/runtime/doc/filetype.txt
+++ b/runtime/doc/filetype.txt
@@ -320,8 +320,8 @@ then Vim will load all plugins in these directories and below:
 Note that the last one is the value of $VIMRUNTIME which has been expanded.

 Note that when using a plugin manager or |packages| many directories will be
-added to 'runtimepath'.  These plugins earch require their own directory,
-don't put them directly in ~/.vim/plugin.
+added to 'runtimepath'.  These plugins each require their own directory, don't
+put them directly in ~/.vim/plugin.

 What if it looks like your plugin is not being loaded?  You can find out what
 happens when Vim starts up by using the |-V| argument: >

Fixed.

h-east commented 6 years ago

>がないのでハイライトされていない。 ←これは却下。(コマンドじゃなくてファイル名一覧なので)

diff --git a/runtime/doc/repeat.txt b/runtime/doc/repeat.txt
index 62464780e..e4eaa07e1 100644
--- a/runtime/doc/repeat.txt
+++ b/runtime/doc/repeat.txt
@@ -604,7 +604,7 @@ bit harder to update to a new version.  A repository can usually be kept
 up-to-date easily, but it requires a program like "git" to be available.
 You can do both, github can automatically create an archive for a release.

-Your directory layout would be like this:
+Your directory layout would be like this: >
    start/foobar/plugin/foo.vim     " always loaded, defines commands
    start/foobar/plugin/bar.vim     " always loaded, defines commands
    start/foobar/autoload/foo.vim   " loaded when foo command used

却下.

h-east commented 6 years ago

全部報告しました。(Chipさんのは送ってない) https://groups.google.com/d/msg/vim_dev/HInqhSuYxL4/3nadubU9BgAJ

k-takata commented 6 years ago

(Chipさんのは送ってない)

私が https://github.com/vim-jp/issues/issues/1032#issuecomment-392785384 で送ったもののことを指していますか?それとも何か追加でありましたか?

h-east commented 6 years ago

あぁ、送ってくれていたんですね。No chip checkでした。:+1:

mnishz commented 6 years ago

Ver. 8.1.0127 です。 コマンド名のバッククォート抜けです。

diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt
index 0206e7efa..c9e0c0575 100644
--- a/runtime/doc/autocmd.txt
+++ b/runtime/doc/autocmd.txt
@@ -661,7 +661,7 @@ DirChanged                  The working directory has changed in response
                                to the |:cd| or |:lcd| commands, or as a
                                result of the 'autochdir' option.
                                The pattern can be:
-                                       "window" to trigger on `:lcd
+                                       "window" to trigger on `:lcd`
                                        "global" to trigger on `:cd`
                                        "auto"   to trigger on 'autochdir'.
                                        "drop"   to trigger on editing a file

Fixed.

mnishz commented 6 years ago

vim-jp/vimdoc-ja-working#281 での指摘事項です。 Ver. 8.1.0137, "Vim Script" -> "Vim script"

diff --git a/runtime/doc/change.txt b/runtime/doc/change.txt
index b59f28f47..ba6ed9c4f 100644
--- a/runtime/doc/change.txt
+++ b/runtime/doc/change.txt
@@ -1451,7 +1451,7 @@ to the name of an external program for Vim to use for text formatting.  The
 program.

                                                         *format-formatexpr*
-The 'formatexpr' option can be set to a Vim Script function that performs
+The 'formatexpr' option can be set to a Vim script function that performs
 reformatting of the buffer.  This should usually happen in an |ftplugin|,
 since formatting is highly dependent on the type of file.  It makes
 sense to use an |autoload| script, so the corresponding script is only loaded

Fixed.

k-takata commented 6 years ago

http://www.leonerd.org.uk/code/libvterm/ で合っていると思います。

h-east commented 6 years ago

あぁ、http://bazaar.~ の方を見てました。。

mnishz commented 6 years ago

vim-jp/vimdoc-ja-working#281 での指摘事項です。 Ver. 8.1.0139、不要な大なり記号

diff --git a/runtime/doc/change.txt b/runtime/doc/change.txt
index b59f28f47..e130032bf 100644
--- a/runtime/doc/change.txt
+++ b/runtime/doc/change.txt
@@ -1485,7 +1485,7 @@ text.  Put it in your autoload directory, e.g. ~/.vim/autoload/format.vim: >

 You can then enable the formatting by executing: >
   setlocal formatexpr=format#Format()
->
+
 Note: this function explicitly returns non-zero when called from insert mode
 (which basically means, text is inserted beyond the 'textwidth' limit).  This
 causes Vim to fall back to reformat the text by using the internal formatter.

Fixed.

mnishz commented 6 years ago

Ver. 8.1.0186

  1. "vim" -> "Vim"
  2. "don't want turn ~ on" -> "don't want to turn ~ on"
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 7d588dc51..64d8469c7 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -4363,7 +4363,7 @@ A jump table for the options with a short description can be found at |Q_op|.
        methods.  Use 'imdisable' to disable XIM then.

        You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
-       via external command if vim is not compiled with the |+xim|,
+       via external command if Vim is not compiled with the |+xim|,
        |+multi_byte_ime| or |global-ime|.

                                                *'imsearch'* *'ims'*
@@ -4483,9 +4483,9 @@ A jump table for the options with a short description can
be found at |Q_op|.
        The highlighting can be set with the 'i' flag in 'highlight'.
        When 'hlsearch' is on, all matched strings are highlighted too while
        typing a search command. See also: 'hlsearch'.
-       If you don't want turn 'hlsearch' on, but want to highlight all matches
-       while searching, you can turn on and off 'hlsearch' with autocmd.
-       Example: >
+       If you don't want to turn 'hlsearch' on, but want to highlight all
+       matches while searching, you can turn on and off 'hlsearch' with
+       autocmd. Example: >
                augroup vimrc-incsearch-highlight
                  autocmd!
                  autocmd CmdlineEnter /,\? :set hlsearch

Fixed.

h-east commented 6 years ago

バッククォート1つ多め。

diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt
index cd2c664f5..9b4657b1f 100644
--- a/runtime/doc/terminal.txt
+++ b/runtime/doc/terminal.txt
@@ -635,7 +635,7 @@ Starting ~
 Load the plugin with this command: >
    packadd termdebug
 <                          *:Termdebug*
-To start debugging use `:Termdebug` or `:TermdebugCommand`` followed by the
+To start debugging use `:Termdebug` or `:TermdebugCommand` followed by the
 command name, for example: >
    :Termdebug vim

Fixed.

mnishz commented 6 years ago

https://github.com/vim-jp/vimdoc-ja-working/pull/295#pullrequestreview-139312246

Ver. 8.1.0209

  1. 80 カラム超え
  2. 余分なスペース

    diff --git a/en/options.txt b/en/options.txt
    index 7d588dc..ef6aff8 100644
    --- a/en/options.txt
    +++ b/en/options.txt
    @@ -6640,7 +6640,8 @@ A jump table for the options with a short description can be found at |Q_op|.
           tabpages     all tab pages; without this only the current tab page
                        is restored, so that you can make a session for each
                        tab page separately
    -          terminal     include terminal windows where the command can be restored
    +          terminal     include terminal windows where the command can be
    +                       restored
           unix         with Unix end-of-line format (single <NL>), even when
                        on Windows or DOS
           winpos       position of the whole Vim window
    @@ -6676,7 +6677,7 @@ A jump table for the options with a short description can be found at |Q_op|.
        Example with escaped space (Vim will do this when initializing the
        option from $SHELL): >
                :set shell=/bin/with\\\ space/sh
    -<      The resulting value of 'shell' is  "/bin/with\ space/sh", two
    +<      The resulting value of 'shell' is "/bin/with\ space/sh", two
        backslashes are consumed by `:set`.
    
        Under MS-Windows, when the executable ends in ".com" it must be

Fixed.

h-east commented 5 years ago

https://github.com/vim-jp/vimdoc-ja-working/pull/297 組み込み関数名をmark up。

diff --git a/runtime/doc/quickfix.txt b/runtime/doc/quickfix.txt
index 95bcfa06d..1399d8bed 100644
--- a/runtime/doc/quickfix.txt
+++ b/runtime/doc/quickfix.txt
@@ -46,7 +46,7 @@ compiler (see |errorformat| below).

                            *quickfix-ID*
 Each quickfix list has a unique identifier called the quickfix ID and this
-number will not change within a Vim session. The getqflist() function can be
+number will not change within a Vim session. The |getqflist()| function can be
 used to get the identifier assigned to a list. There is also a quickfix list
 number which may change whenever more than ten lists are added to a quickfix
 stack.
@@ -68,7 +68,7 @@ the location list is destroyed.
 Every quickfix and location list has a read-only changedtick variable that
 tracks the total number of changes made to the list.  Every time the quickfix
 list is modified, this count is incremented. This can be used to perform an
-action only when the list has changed.  The getqflist() and getloclist()
+action only when the list has changed.  The |getqflist()| and |getloclist()|
 functions can be used to query the current value of changedtick.  You cannot
 change the changedtick variable.

@@ -602,7 +602,7 @@ present).  Examples: >
    echo getloclist(2, {'winid' : 1}).winid
 <
                            *getqflist-examples*
-The getqflist() and getloclist() functions can be used to get the various
+The |getqflist()| and |getloclist()| functions can be used to get the various
 attributes of a quickfix and location list respectively. Some examples for
 using these functions are below:
 >
@@ -659,7 +659,7 @@ using these functions are below:
     :echo getloclist(3, {'winid' : 0}).winid
 <
                            *setqflist-examples*
-The setqflist() and setloclist() functions can be used to set the various
+The |setqflist()| and |setloclist()| functions can be used to set the various
 attributes of a quickfix and location list respectively. Some examples for
 using these functions are below:
 >

Fixed.

h-east commented 5 years ago

ここまでの分 vim_devに送付:+1: https://groups.google.com/d/msg/vim_dev/UImMZ3IGizg/fjAh09o1BwAJ

h-east commented 5 years ago

報告分すべて反映されました。 https://github.com/vim/vim/commit/d473c8c101262702ea9eeb14907ee20a786942b2

mnishz commented 5 years ago

Ver. 8.1.0290

  1. remote_startserver() に無関係と思われる説明が付いています。remote_send() からヤンクして、その残骸ではないかと。
  2. setbufline() のサマリーのほうの引数名が間違っているように思います。:h setbufline() のほうに合わせました。("line" -> "text")
  3. test_feedinput() のサマリーのほうの引数名がありません。
  4. count() のサマリーのほうの引数名が間違っているように思います。:h count() のほうに合わせました。("list" -> "comp")
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 53ee2094e..6aa48dccf 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -2324,7 +2324,6 @@ remote_read({serverid} [, {timeout}])
 remote_send({server}, {string} [, {idvar}])
                                String  send key sequence
 remote_startserver({name})     none    become server {name}
-                               String  send key sequence
 remove({list}, {idx} [, {end}])        any     remove items {idx}-{end} from {list}
 remove({dict}, {key})          any     remove entry {key} from {dict}
 rename({from}, {to})           Number  rename (move) file from {from} to {to}
@@ -2349,8 +2348,8 @@ searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]])
 server2client({clientid}, {string})
                                Number  send reply string
 serverlist()                   String  get a list of available servers
-setbufline({expr}, {lnum}, {line})
-                               Number  set line {lnum} to {line} in buffer
+setbufline({expr}, {lnum}, {text})
+                               Number  set line {lnum} to {text} in buffer
                                        {expr}
 setbufvar({expr}, {varname}, {val})
                                none    set {varname} in buffer {expr} to {val}
@@ -2456,7 +2455,7 @@ term_wait({buf} [, {time}])       Number  wait for screen to b
e updated
 test_alloc_fail({id}, {countdown}, {repeat})
                                none    make memory allocation fail
 test_autochdir()               none    enable 'autochdir' during startup
-test_feedinput()               none    add key sequence to input buffer
+test_feedinput({string})       none    add key sequence to input buffer
 test_garbagecollect_now()      none    free memory right now for testing
 test_ignore_error({expr})      none    ignore a specific error
 test_null_channel()            Channel null value for testing
@@ -2101,8 +2101,8 @@ confirm({msg} [, {choices} [, {default} [, {type}]]])
 copy({expr})                   any     make a shallow copy of {expr}
 cos({expr})                    Float   cosine of {expr}
 cosh({expr})                   Float   hyperbolic cosine of {expr}
-count({list}, {expr} [, {ic} [, {start}]])
-                               Number  count how many {expr} are in {list}
+count({comp}, {expr} [, {ic} [, {start}]])
+                               Number  count how many {expr} are in {comp}
 cscope_connection([{num}, {dbpath} [, {prepend}]])
                                Number  checks existence of cscope connection
 cursor({lnum}, {col} [, {off}])

Fixed.

mnishz commented 5 years ago

eval.txt に関連して他に気が付いたのが、:h functions の中の以下の 2 点です。

  1. appendbufline() の項目がない。:h appendbufline() 自体はある。
  2. prompt_addtext() という存在しない関数がある。

prompt_addtext() に関しては、以下の commit で help の記述が入ったようですが、関数自体が src の中に見当たらないです。一度も実装されていなんじゃないかと思います。消し忘れた?同時に入った prompt_setcallback() はありました。 https://github.com/vim/vim/commit/f273245f6433d5d43a5671306b520a3230c35787#diff-bea881dfa9626bab7141337b0fcdb23eR2297 ちなみに runtime/syntax/vim.vim の vimFuncName の中にもいるようなので、これも直したほうがよさそうですね。他には見当たりませんでした。

ここ (typo報告スレ) でやる内容とは違いますでしょうか。

h-east commented 5 years ago

「1.」は報告対象です。 「2.」は私もそのhelpが入ったpatchを認識していたのですが、「後で実装されますよね?」と思ったまま忘れてしまってました:sweat_drops:。そろそろ聞いてみた方が良いですね。

ちなみに runtime/syntax/vim.vim の vimFuncName の中にもいる

runtime/syntax/vim.vim はhelp(doc/*.txt)から抽出して作成されているので、help(doc/*.txt)が修正されれば自動的に直ります。

ここ (typo報告スレ) でやる内容とは違いますでしょうか。

問題ないと思います。むしろありがとうございます!

k-takata commented 5 years ago

prompt_addtext() という存在しない関数がある。

Bramは実装したいと考えているがまだ実装していない&仕様について意見募集中、という状態のはずです。

h-east commented 5 years ago

以下のhelpファイルだけ最下行のmodelineにfo=tcq2が書かれている。 なぜこの3ファイルだけなのかと、必要なのか必要ならfo+=2にしてくれないかを質問、提案する。 help.txt os_390.txt os_win32.txt

(Fixed. fo=tcq2:が削除されました。)

mnishz commented 5 years ago

返事遅れてしまいましたが、承知いたしました! お二人とも返信どうもありがとうございました。

mnishz commented 5 years ago

deletebufline() の説明文ですが、"setline() と同じ" ではなくて "getline() と同じ" が正しいように思うのですがどうでしょうか。 setline() は 1 行だけ指定ですが、getline() は deletebufline() と同じように始まりと終わりを指定します (することができます)。 また、"getline() と同じ" と書いてある箇所はたくさんありますが、"setline() と同じ" と書いてあるのはdeletebufline() だけです。

diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 53ee2094e..6d67f6d50 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -3536,7 +3536,7 @@ deletebufline({expr}, {first} [, {last}])         *deletebufline()
*

                For the use of {expr}, see |bufname()| above.

-               {first} and {last} are used like with |setline()|. Note that
+               {first} and {last} are used like with |getline()|. Note that
                when using |line()| this refers to the current buffer. Use "$"
                to refer to the last line in buffer {expr}.

Fixed.

h-east commented 5 years ago

@mnishz さんの指摘通りだと思います。(getline()が正解)

mnishz commented 5 years ago

Ver. 8.1.0290

  1. swapinfo() のタグ抜け
  2. "VIM" -> "Vim"
  3. "replace by" -> "replaced by"
    
    diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
    index 53ee2094e..d9dacb2c5 100644
    --- a/runtime/doc/eval.txt
    +++ b/runtime/doc/eval.txt
    @@ -8002,14 +8002,14 @@ substitute({expr}, {pat}, {sub}, {flags})               *substitute()*
                |submatch()| returns.  Example: >
                   :echo substitute(s, '%\(\x\x\)', {m -> '0x' . m[1]}, 'g')

-swapinfo({fname}) swapinfo() +swapinfo({fname}) swapinfo() The result is a dictionary, which holds information about the swapfile {fname}. The available fields are:

Fixed. (「1. swapinfo() のタグ抜け」のみ) All fixed.

tyru commented 5 years ago

typo かは微妙ですか平仄が取れてないと感じたので。

後者はさらに微妙ですがとりあえず報告まで。

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 2343d6342..830af0589 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1997,8 +1997,8 @@ A jump table for the options with a short description can be found at |Q_op|.
    displayed.  E.g., when moving vertically it may change column.

-'conceallevel' 'cole'      *'conceallevel'* *'cole'*
-           number (default 0)
+                       *'conceallevel'* *'cole'*
+'conceallevel' 'cole'  number (default 0)
            local to window
            {not in Vi}
            {not available when compiled without the |+conceal|
@@ -5914,7 +5914,7 @@ A jump table for the options with a short description can be found at |Q_op|.
    security reasons.

                        *'printencoding'* *'penc'*
-'printencoding' 'penc' String  (default empty, except for some systems)
+'printencoding' 'penc' string  (default empty, except for some systems)
            global
            {not in Vi}
            {only available when compiled with the |+printer|
@@ -5923,7 +5923,7 @@ A jump table for the options with a short description can be found at |Q_op|.
    See |penc-option|.

                        *'printexpr'* *'pexpr'*
-'printexpr' 'pexpr'    String  (default: see below)
+'printexpr' 'pexpr'    string  (default: see below)
            global
            {not in Vi}
            {only available when compiled with the |+printer|

Fixed.

mnishz commented 5 years ago

Ver. 8.1.0329 何をモードとするかによって少し微妙な感じはありますが、"four" -> "five" のほうが適切かと思いました。 https://github.com/vim-jp/vimdoc-ja-working/pull/307 関連

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 2343d6342..94b986232 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -5392,7 +5392,7 @@ A jump table for the options with a short description can be found at |Q_o
p|.
                h       all previous modes when editing a help file
                a       all previous modes
                r       for |hit-enter| and |more-prompt| prompt
-       Normally you would enable the mouse in all four modes with: >
+       Normally you would enable the mouse in all five modes with: >
                :set mouse=a
 <      When the mouse is not enabled, the GUI will still use the mouse for
        modeless selection.  This doesn't move the text cursor.

Fixed.

tyru commented 5 years ago

appendbufline() 関数が :h functions に無いです。

diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 2e5bf7f3d..e6e258ee9 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -2017,6 +2017,12 @@ add({list}, {item})      List    append {item} to |List| {list}
 and({expr}, {expr})        Number  bitwise AND
 append({lnum}, {string})   Number  append {string} below line {lnum}
 append({lnum}, {list})     Number  append lines {list} below line {lnum}
+appendbufline({expr}, {lnum}, {string})
+               Number  append {string} below line {lnum}
+                   to buffer {expr}
+appendbufline({expr}, {lnum}, {list})
+               Number  append lines {list} below line {lnum}
+                   to buffer {expr}
 argc()             Number  number of files in the argument list
 argidx()           Number  current index in the argument list
 arglistid([{winnr} [, {tabnr}]]) Number    argument list id

Fixed. 第3引数は {text} に統一。

h-east commented 5 years ago

提案。コマンド名でhelpが引けるようにしてはどうか?

diff --git a/runtime/doc/quickfix.txt b/runtime/doc/quickfix.txt
index 3ef3be8e6..4e4390957 100644
--- a/runtime/doc/quickfix.txt
+++ b/runtime/doc/quickfix.txt
@@ -1551,7 +1551,7 @@ The backslashes before the pipe character are required to avoid it to be
 recognized as a command separator.  The backslash before each space is
 required for the set command.

-                       *cfilter-plugin*
+                       *cfilter-plugin* *Cfilter* *Lfilter*
 If you have too many matching messages, you can use the cfilter plugin to
 reduce the number of entries.  Load the plugin with: >
    packadd cfilter

Fixed.

k-takata commented 5 years ago

append() と appendbufline() のパラメーターの表記が統一されていないのがちょっと気になりますね。

function-list:

append({lnum}, {string})    Number  append {string} below line {lnum}
append({lnum}, {list})      Number  append lines {list} below line {lnum}

(上記の指摘通り、appendbufline() は載っていない。) appendの第2引数は {string} と {list} の2通り。

本文:

append({lnum}, {expr})                  *append()*
appendbufline({expr}, {lnum}, {text})           *appendbufline()*

appendの第2引数は {expr}、appendbuflineの第3引数は {text}。

どうするのがよいかはよく分からず。

追記: Fixed. 最終引数名は {text} に統一された。

mnishz commented 5 years ago
  1. term_dumpdiff() の説明ですが、各パートの分割はダッシュではなくて等号 '=' で分けられていると思います。
  2. (追記) term_getcursor() の "blink" の説明が "visible" と同じになっています。"not blinking" をあえて言い換えるとすれば "always visible" とかですかね。

    diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
    index e83839563..5562f758d 100644
    --- a/runtime/doc/eval.txt
    +++ b/runtime/doc/eval.txt
    @@ -8337,7 +8337,7 @@ term_dumpdiff({filename}, {filename} [, {options}])
                The top part of the buffer contains the contents of the first
                file, the bottom part of the buffer contains the contents of
                the second file.  The middle part shows the differences.
    -               The parts are separated by a line of dashes.
    +               The parts are separated by a line of equals.
    
                If the {options} argument is present, it must be a Dict with
                these possible members:
    @@ -8420,8 +8420,8 @@ term_getcursor({buf})                                     *term_getcursor()*
                "dict" can have these members:
                   "visible"    one when the cursor is visible, zero when it
                                is hidden.
    -                  "blink"      one when the cursor is visible, zero when it
    -                               is hidden.
    +                  "blink"      one when the cursor is blinking, zero when it
    +                               is not blinking.
                   "shape"      1 for a block cursor, 2 for underline and 3
                                for a vertical bar.

Fixed.

tyru commented 5 years ago

@k-takata help appendbufline() が {text} になってますからね… どうすればいいんでしょう… パッチ出す時 Bram に訊いて、どっちも expr か text に直してもらうのがいいと思いますが…

k-takata commented 5 years ago

関数リストのところは、append() に合わせて appendbufline() も2つ書いておくのがよいのかもしれません。本文はBramの判断次第ですかね?

tyru commented 5 years ago

@k-takata 確かに、ありがとうございます。パッチ更新しました。 https://github.com/vim-jp/issues/issues/1172#issuecomment-417345994 追記:直ってませんでした。もっかい修正… (履歴が見れるようになって良かった)

h-east commented 5 years ago

そろそろvim_devに送りません? (私のmodelineのfo=tcq2のやつと提案のやつは除外してもらって構いません)

私、不具合の解析をやりかけているので、どなたかやっていただけると有り難いです。

mnishz commented 5 years ago

そうですね、手が空いたときにまとめて送ってみます。vim-dev のメーリングリストに投げればいいんですよね?

  1. eval.txt で、コマンドではない (と言うと少し微妙ですが) 部分がバッククォートで囲まれているのでタグへのリンクに置き換えました。 -> 不要とのこと、diffからは削除。https://github.com/vim-jp/issues/issues/1172#issuecomment-417946046
  2. 不要と思われるバッククォートを削除しました。

    diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
    index e83839563..9c1223537 100644
    --- a/runtime/doc/eval.txt
    +++ b/runtime/doc/eval.txt
    @@ -8461,7 +8461,7 @@ term_getscrolled({buf})                                   *term_getscrolled()*
                used for |term_getline()| and |getline()|, so that: >
                        term_getline(buf, N)
    <              is equal to: >
    -                       `getline(N + term_getscrolled(buf))
    +                       getline(N + term_getscrolled(buf))
    <              (if that line exists).
    
                {buf} is used as with |term_getsize()|.

Fixed.

h-east commented 5 years ago

vim-dev のメーリングリストに投げればいいんですよね?

はい。もしくはGitHubでPull Requestするかですね。 どっちでも良いです。

k-takata commented 5 years ago

eval.txt で、コマンドではない (と言うと少し微妙ですが) 部分がバッククォートで囲まれているのでタグへのリンクに置き換えました。

これは修正不要です。以前指摘したところ、バッククォートはコマンドや式に使うのだと言われました。(:help help-writing にはコマンドとしか書いてませんが…)

h-east commented 5 years ago

https://github.com/vim-jp/issues/issues/1172#issuecomment-415962354 の「1. swapinfo() のタグ抜け」は修正されましたね。 https://github.com/vim/vim/commit/20aac6c1126988339611576d425965a25a777658#diff-bea881dfa9626bab7141337b0fcdb23eR8016

mnishz commented 5 years ago

承知いたしました!お二人ともどうもありがとうございます。

mnishz commented 5 years ago

https://github.com/vim-jp/vimdoc-ja-working/pull/303#discussion_r216111550 機能へのリンク漏れです。

diff --git a/en/eval.txt b/en/eval.txt
index d51b92c..2f4b46a 100644
--- a/en/eval.txt
+++ b/en/eval.txt
@@ -2796,15 +2796,15 @@ balloon_show({expr})                                    *balloon_show()*

                When showing a balloon is not possible nothing happens, no
                error message.
-               {only available when compiled with the +balloon_eval or
-               +balloon_eval_term feature}
+               {only available when compiled with the |+balloon_eval| or
+               |+balloon_eval_term| feature}

 balloon_split({msg})                                   *balloon_split()*
                Split {msg} into lines to be displayed in a balloon.  The
                splits are made for the current window size and optimize to
                show debugger output.
                Returns a |List| with the split lines.
-               {only available when compiled with the +balloon_eval_term
+               {only available when compiled with the |+balloon_eval_term|
                feature}

Fixed.

mnishz commented 5 years ago

'formatoptions' の質問以外すべて報告いたしました。 https://groups.google.com/forum/#!topic/vim_dev/cnzH7CjC4oM

mnishz commented 5 years ago

Example 3 だけ見出しがついていませんでした。 https://github.com/vim-jp/vimdoc-ja-working/pull/315

diff --git a/runtime/doc/gui_x11.txt b/runtime/doc/gui_x11.txt
index a95b9fd6b..76e2ac278 100644
--- a/runtime/doc/gui_x11.txt
+++ b/runtime/doc/gui_x11.txt
@@ -496,7 +496,7 @@ unexpectedly less attractive or even deteriorates their usability.  Keep this
 in mind always when you try improving a theme.

-Example 3.  border color
+Example 3.  border color ~

 To eliminate borders when maximized: >

Fixed.