From 97126bfa020f714d78e5e6f82b59c697ce7dd467 Mon Sep 17 00:00:00 2001 From: Björn Linse Date: Sun, 30 Apr 2017 09:16:11 +0200 Subject: api: deprecate obsolete nvim_buf_get_number function --- runtime/doc/msgpack_rpc.txt | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'runtime') 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 -- cgit