diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2016-10-28 14:53:09 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-28 14:53:09 +0200 |
| commit | 5b514b59880313acafd5c339d4090319ed525ce1 (patch) | |
| tree | 1052206a6bf80ad1ac3cff490e7dfec1fc7fce9e /runtime | |
| parent | fb4d5b05166235ae32db48cb7eb8d3776ea8386a (diff) | |
| parent | c5f5f427c6f8d1b4136bf41171f8f0980561080e (diff) | |
| download | rneovim-5b514b59880313acafd5c339d4090319ed525ce1.tar.gz rneovim-5b514b59880313acafd5c339d4090319ed525ce1.tar.bz2 rneovim-5b514b59880313acafd5c339d4090319ed525ce1.zip | |
Merge #5535 from justinmk/api_level
api: Nvim version + API level
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 7 | ||||
| -rw-r--r-- | runtime/doc/msgpack_rpc.txt | 2 |
2 files changed, 6 insertions, 3 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index c3d7fdb35b..976b852bdb 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -51,9 +51,10 @@ Tabpage -> enum value kObjectTypeTabpage Nvim exposes metadata about the API as a Dictionary with the following keys: -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. +version Nvim version, API level/compatibility +functions API function signatures +types Custom handle types defined by Nvim +error_types Possible error types returned by API functions This metadata is mostly useful for external programs accessing the API via RPC, see |rpc-api|. diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt index b3fed9e756..757f5574d4 100644 --- a/runtime/doc/msgpack_rpc.txt +++ b/runtime/doc/msgpack_rpc.txt @@ -168,6 +168,8 @@ API metadata object ~ API clients exist to hide msgpack-rpc details. The API metadata object contains information that makes this task easier (see also |rpc-types|): + - The "version" key contains the Nvim version, API level, and API + backwards-compatibility level. - The "functions" key contains a list of metadata objects for individual functions. - Each function metadata object has |rpc-types| information about the return |