kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-31 17:13:26 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: More consistent descriptions of rpc*() funcs

Browse Source 
- Remove note about how {channel} is rpcstop's only argument; just
  mention {channel} at the beginning like the other descriptions.
- Small grammar fixes
This commit is contained in:
Michael Reed 2014-12-08 18:46:15 -05:00
parent 7f30439d0f
commit 215603ebd7
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
runtime/doc/eval.txt
View File

@ -5104,8 +5104,8 @@ rpcrequest({channel}, {method}[, {args}...]) {Nvim} *rpcrequest()*
:let result = rpcrequest(rpc_chan, "func", 1, 2, 3)
rpcstart({prog}[, {argv}]) {Nvim} *rpcstart()*
Spawns {prog} as a job(optionally passing the {argv} list),
and opens a |msgpack-rpc| channel with the spawned process
Spawns {prog} as a job (optionally passing the list {argv}),
and opens a |msgpack-rpc| channel with the spawned process's
stdin/stdout. It returns:
- The channel id on success, which is used by |rpcrequest()|,
|rpcnotify()| and |rpcstop()|
@ -5114,10 +5114,9 @@ rpcstart({prog}[, {argv}]) {Nvim} *rpcstart()*
:let rpc_chan = rpcstart('prog', ['arg1', 'arg2'])
rpcstop({channel}) {Nvim} *rpcstop()*
Closes a |msgpack-rpc| channel, possibly created via
|rpcstart()| (Though it will also close channels created by
connections to |$NVIM_LISTEN_ADDRESS|). It accepts the rpc
channel id as only argument.
Closes a |msgpack-rpc| {channel}, possibly created via
|rpcstart()|. Also closes channels created by connections to
|$NVIM_LISTEN_ADDRESS|.
screenattr(row, col) *screenattr()*
Like screenchar(), but return the attribute. This is a rather