diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2016-09-17 06:30:36 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-17 06:30:36 +0200 |
| commit | dc6cc4787c16d2b339699c12136c400c1b3b5cef (patch) | |
| tree | b72a4d85ab76ad7ce4121a15e3d70c9534293e03 /runtime/doc/msgpack_rpc.txt | |
| parent | 3a9da803ccdf77f20c95bb85a047c9ec532e9d1f (diff) | |
| download | rneovim-dc6cc4787c16d2b339699c12136c400c1b3b5cef.tar.gz rneovim-dc6cc4787c16d2b339699c12136c400c1b3b5cef.tar.bz2 rneovim-dc6cc4787c16d2b339699c12136c400c1b3b5cef.zip | |
api: Establish API naming convention. (#5344)
old name: new name:
--------------------------------------------------
nvim_name_to_color nvim_get_color_by_name
nvim_get_current_buffer nvim_get_current_buf
nvim_get_current_window nvim_get_current_win
nvim_get_buffers nvim_list_bufs
nvim_get_tabpages nvim_list_tabpages
nvim_get_windows nvim_list_wins
nvim_set_current_buffer nvim_set_current_buf
nvim_set_current_window nvim_set_current_win
nvim_change_directory nvim_set_current_dir
nvim_tabpage_get_window nvim_tabpage_get_win
nvim_tabpage_get_windows nvim_tabpage_list_wins
nvim_win_get_buffer nvim_win_get_buf
nvim_report_error nvim_err_writeln
Helped-by: Björn Linse <bjorn.linse@gmail.com>
Helped-by: ZyX <kp-pav@yandex.ru>
Helped-by: James McCoy <jamessan@jamessan.com>
Diffstat (limited to 'runtime/doc/msgpack_rpc.txt')
| -rw-r--r-- | runtime/doc/msgpack_rpc.txt | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt index 59e9e44f8f..b3fed9e756 100644 --- a/runtime/doc/msgpack_rpc.txt +++ b/runtime/doc/msgpack_rpc.txt @@ -124,17 +124,16 @@ You can also embed an Nvim instance via |jobstart()|, and communicate using ============================================================================== 4. Implementing API clients *rpc-api-client* *api-client* -All external UIs and remote plugins (as opposed to regular Vim plugins) are -"clients" in general; but we call something an "API client" if its purpose is -to abstract or wrap the RPC API for the convenience of other applications -(just like a REST client or SDK such as boto3 for AWS: you can speak AWS REST -using an HTTP client like curl, but boto3 wraps that in a convenient python -interface). For example, the lua-client is an API client: - https://github.com/neovim/lua-client - -The Python client (pip package "neovim") is the reference implementation of an -API client. It is always up-to-date with the Nvim API, so its source code and -test suite are an authoritative reference. +"API clients" wrap the Nvim API to provide idiomatic "SDKs" for their +respective platforms (see |dev-jargon|). You can build a new API client for +your favorite platform or programming language. + +Existing API clients are listed here: + https://github.com/neovim/neovim/wiki/Related-projects#api-clients + +The Python client is the reference implementation for API clients. It is +always up-to-date with the Nvim API, so its source code and test suite are +authoritative references. https://github.com/neovim/python-client API client implementation guidelines ~ |