diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2016-10-31 16:16:37 +0100 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2016-10-31 16:16:37 +0100 |
| commit | e427cdf2d4799971cf45b36ea7344f37f115d02b (patch) | |
| tree | ac6db0d53e2bdbd22a08412906c82ad1af3f331f | |
| parent | b172f9904f03331041c1c53d5c243e7c9b7c4284 (diff) | |
| download | rneovim-e427cdf2d4799971cf45b36ea7344f37f115d02b.tar.gz rneovim-e427cdf2d4799971cf45b36ea7344f37f115d02b.tar.bz2 rneovim-e427cdf2d4799971cf45b36ea7344f37f115d02b.zip | |
doc/api: Closes #1842
| -rw-r--r-- | runtime/doc/api.txt | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 976b852bdb..171b0124f6 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -49,15 +49,20 @@ Tabpage -> enum value kObjectTypeTabpage ============================================================================== 3. API metadata *api-metadata* -Nvim exposes metadata about the API as a Dictionary with the following keys: - -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|. +Nvim exposes API metadata as a Dictionary. Some items are described below: + +version Nvim version, API level/compatibility +version.api_level Current API level +version.api_compatible API is backwards-compatible with this level +version.api_prerelease Declares the current API level as unstable > + (version.api_prerelease && fn.since == version.api_level) +functions API function signatures +{fn}.since API level where function {fn} was introduced +{fn}.deprecated_since API level where function {fn} was deprecated +types Custom handle types defined by Nvim +error_types Possible error types returned by API functions + +External programs ("clients") can use the metadata to discover the |rpc-api|. ============================================================================== 4. Buffer highlighting *api-highlights* |