diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2016-06-13 02:11:12 -0400 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2016-06-15 19:29:26 -0400 |
| commit | 23a3e58f02e37ed5c6f8fa1f4758d0ebe1aed8d3 (patch) | |
| tree | 4afeb551e0a0a2886b82f9682ddd40fbc9254e95 /runtime/doc/api.txt | |
| parent | bd20892bdf15e45c4ea5827250e3aa0c2ace24a0 (diff) | |
| download | rneovim-23a3e58f02e37ed5c6f8fa1f4758d0ebe1aed8d3.tar.gz rneovim-23a3e58f02e37ed5c6f8fa1f4758d0ebe1aed8d3.tar.bz2 rneovim-23a3e58f02e37ed5c6f8fa1f4758d0ebe1aed8d3.zip | |
doc: msgpack_rpc: De-emphasize the transport protocol.
Tighten our jargon, avoid mentioning "msgpack" everywhere we mention the
RPC API. Prefer "RPC API" when speaking about the remote API.
Though it's conceivable that we may one day support some protocol other
than msgpack, that isn't relevant to most of our discussion of the API,
including this document.
The file name msgpack_rpc.txt is preserved to avoid totally breaking
URLs.
Diffstat (limited to 'runtime/doc/api.txt')
| -rw-r--r-- | runtime/doc/api.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index ca79465e0d..c35c393c8b 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -14,7 +14,7 @@ The C API of Nvim *nvim-api* 1. Introduction *nvim-api-intro* Nvim defines a C API as the primary way for external code to interact with -the NVim core. In the present version of Nvim the API is primarily used by +the Nvim core. In the present version of Nvim the API is primarily used by external processes to interact with Nvim using the msgpack-rpc protocol, see |msgpack-rpc|. The API will also be used from vimscript to access new Nvim core features, but this is not implemented yet. Later on, Nvim might be embeddable @@ -54,8 +54,8 @@ functions calling signature of the API functions types The custom handle types defined by Nvim error_types The possible kinds of errors an API function can exit with. -This metadata is mostly useful for external programs accessing the api over -msgpack-api, see |msgpack-rpc-api|. +This metadata is mostly useful for external programs accessing the API via +RPC, see |rpc-api|. ============================================================================== 4. Buffer highlighting *nvim-api-highlights* |