Hi Bram and developers,
I'm attaching a document patch that fixes some issues discussed in the
following link (vim-jp, in Japanese).
https://github.com/vim-jp/issues/issues/1172
eval.txt
1. Add appendbufline() to short explanation in Builtin Functions list
2. Modify an argument name of count() from "list" to "comp" according to
the full explanation
3. Remove unnecessary text from remote_startserver()
4. Modify an argument name of setbufline() from "line" to "text" according
to the full explanation
5. Add an argument "string" to test_feedinput() according to the full
explanation
6. Add a link to balloon_eval and balloon_eval_term
7. s/setline/getline
8. s/VIM/Vim
9. s/replace/replaced
10. s/dashes/equals
11. Modify the explanation of blink in term_getcursor()
12. Remove unnecessary "`"
options.txt
1. Move the title of 'conceallevel' option so that it would match with
other functions' form
2. s/four/five
3. s/String/string
quickfix.txt
1. Add *Cfilter* and *Lfilter* (This is not a fix, but just a suggestion.)
There is another discussion about the argument name of append() and
appendbufline(). It might be better to use the same word like {text} for
consistency.
The full explanation of append() shows that {expr} works as list or text, and
there are two concrete form about that in short explanation ({string} and
{list}). Meanwhile, {expr} has another meaning (buffer) for appendbufline(),
and {text} has those meanings instead.
In short explanation
append({lnum}, {string})
append({lnum}, {list})
appendbufline({expr}, {lnum}, {string}) (added by this patch)
appendbufline({expr}, {lnum}, {list}) (added by this patch)
In full explanation
append({lnum}, {expr})
appendbufline({expr}, {lnum}, {text})
Please change or remove if needed. Thank you.
Best Regards,
Masato Nishihata (mnishz)
--
--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php
---
You received this message because you are subscribed to the Google Groups
"vim_dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index a5c8a13e9..25b3a94ea 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -2024,6 +2024,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
@@ -2108,8 +2114,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}])
@@ -2331,7 +2337,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}
@@ -2356,8 +2361,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}
@@ -2465,7 +2470,7 @@ term_wait({buf} [, {time}]) Number wait for screen to be 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
@@ -2800,15 +2805,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}
*browse()*
@@ -3549,7 +3554,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}.
@@ -8027,11 +8032,11 @@ substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
swapinfo({fname}) *swapinfo()*
The result is a dictionary, which holds information about the
swapfile {fname}. The available fields are:
- version VIM version
+ version Vim version
user user name
host host name
fname original file name
- pid PID of the VIM process that created the swap
+ pid PID of the Vim process that created the swap
file
mtime last modification time in seconds
inode Optional: INODE number of the file
@@ -8131,7 +8136,7 @@ synconcealed({lnum}, {col}) *synconcealed()*
concealable region if there are two consecutive regions
with the same replacement character. For an example, if
the text is "123456" and both "23" and "45" are concealed
- and replace by the character "X", then:
+ and replaced by the character "X", then:
call returns ~
synconcealed(lnum, 1) [0, '', 0]
synconcealed(lnum, 2) [1, 'X', 1]
@@ -8359,7 +8364,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:
@@ -8452,8 +8457,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.
@@ -8485,7 +8490,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()|.
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index a02618af4..fad46b1c7 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1999,8 +1999,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|
@@ -5424,7 +5424,7 @@ A jump table for the options with a short description can be found at |Q_op|.
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.
@@ -5946,7 +5946,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|
@@ -5955,7 +5955,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|
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
