diff options
author | Michael Reed <m.reed@mykolab.com> | 2014-12-08 18:46:15 -0500 |
---|---|---|
committer | Michael Reed <m.reed@mykolab.com> | 2015-01-11 16:50:23 -0500 |
commit | 215603ebd7b71b3e4152d049e35c359853249125 (patch) | |
tree | bae63d8888aae077d488a44669791257560b15c4 | |
parent | 7f30439d0f4d8d7e6b18f56d83d6fe868c84318c (diff) | |
download | rneovim-215603ebd7b71b3e4152d049e35c359853249125.tar.gz rneovim-215603ebd7b71b3e4152d049e35c359853249125.tar.bz2 rneovim-215603ebd7b71b3e4152d049e35c359853249125.zip |
docs: More consistent descriptions of rpc*() funcs
- Remove note about how {channel} is rpcstop's only argument; just
mention {channel} at the beginning like the other descriptions.
- Small grammar fixes
-rw-r--r-- | runtime/doc/eval.txt | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 6ffa37ac39..5ee66fc43b 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -5100,12 +5100,12 @@ rpcnotify({channel}, {event}[, {args}...]) {Nvim} *rpcnotify()* rpcrequest({channel}, {method}[, {args}...]) {Nvim} *rpcrequest()* Sends a request to {channel} to invoke {method} via |msgpack-rpc| and blocks until a response is received. - Example: > + Example: > :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 |