Skip to content

Commit 6b59f1e

Browse files
author
skywind3000
committed
update doc
1 parent da843f9 commit 6b59f1e

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README-cn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@
172172
| `-pos=?` | "bottom" | 当用 `-mode=term` 在内置终端运行命令时, `-pos` 用于指定内置终端窗口位置, 可以设置成 `"tab"``"curwin"``"top"``"bottom"``"left"` 以及 `"right"`|
173173
| `-rows=num` | 0 | 内置终端窗口的高度。|
174174
| `-cols=num` | 0 | 内置终端窗口的宽度。|
175-
| `-errorformat=?` | `未设置` | 用于 quickfix 中匹配错误输出的格式字符串,如果未提供,则使用当前 `&errorformat` 的值。 |
175+
| `-errorformat=?` | `未设置` | 用于 quickfix 中匹配错误输出的格式字符串,如果未提供,则使用当前 `&errorformat` 的值。注意 `%` 需要转写成 `\%` |
176176

177177
所有的这些配置参数都必须放在具体 shell 命令 **前面**,因为没有任何 shell 命令使用 `-` 开头,因此很容易区分哪里是命令的开始。如果你确实有一条 shell 命令是减号开头的,那么为了明显区别参数和命令,可以在命令前面放一个 `@` 符号,那么 AsyncRun 在解析参数时碰到 `@` 就知道参数结束了,后面都是命令。
178178

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ There can be some options before your `[cmd]`:
172172
| `-pos=?` | "bottom" | When using internal terminal with `-mode=term`, `-pos` is used to specify where to split the terminal window, it can be one of `"tab"`, `"curwin"`, `"top"`, `"bottom"`, `"left"` and `"right"`. |
173173
| `-rows=num` | 0 | When using a horizontal split terminal, this value represents the height of terminal window. |
174174
| `-cols=num` | 0 | When using a vertical split terminal, this value represents the width of terminal window. |
175-
| `-errorformat=?` | `unset` | errorformat for error matching, if it is unprovided, use current `&errorformat` value. |
175+
| `-errorformat=?` | `unset` | errorformat for error matching, if it is unprovided, use current `&errorformat` value. Beware that `%` needs to be escaped into `\%`. |
176176

177177
All options must start with a minus and position **before** `[cmd]`. Since no shell command string starts with a minus. So they can be distinguished from shell command easily without any ambiguity.
178178

0 commit comments

Comments
 (0)