diff options
| author | Björn Linse <bjorn.linse@gmail.com> | 2017-04-30 09:16:11 +0200 |
|---|---|---|
| committer | Björn Linse <bjorn.linse@gmail.com> | 2017-04-30 11:04:10 +0200 |
| commit | 97126bfa020f714d78e5e6f82b59c697ce7dd467 (patch) | |
| tree | 4156913922b54b287bdefe62f7fa2cba3637517b /runtime | |
| parent | 0df1b6655be5385c9cbb70dca1c042c6447ec50b (diff) | |
| download | rneovim-97126bfa020f714d78e5e6f82b59c697ce7dd467.tar.gz rneovim-97126bfa020f714d78e5e6f82b59c697ce7dd467.tar.bz2 rneovim-97126bfa020f714d78e5e6f82b59c697ce7dd467.zip | |
api: deprecate obsolete nvim_buf_get_number function
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/msgpack_rpc.txt | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt index 261e68cfb1..c5c0392d96 100644 --- a/runtime/doc/msgpack_rpc.txt +++ b/runtime/doc/msgpack_rpc.txt @@ -221,7 +221,10 @@ Special types (msgpack EXT) ~ An API method expecting one of these types may be passed an integer instead, although they are not interchangeable. For example, a Buffer may be passed as -an integer, but not a Window or Tabpage. +an integer, but not as a Window or Tabpage. The data in the EXT object is the +object id encodes as a msgpack integer. For buffers this is equal to the +buffer number and for windows the window id. For tabpages this is not equal to +tabpage numbers. The most reliable way of determining the type codes for the special Nvim types is to inspect the `types` key of metadata dictionary returned by the |