api/documentation: Add a warning that nil may mean v:null

1 files changed, 4 insertions, 1 deletions

diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c
index 075f101f61..a01188f98c 100644
--- a/src/nvim/api/buffer.c
+++ b/src/nvim/api/buffer.c
@@ -429,7 +429,10 @@ Object buffer_get_var(Buffer buffer, String name, Error *err)
 /// @param name The variable name
 /// @param value The variable value
 /// @param[out] err Details of an error that may have occurred
-/// @return The old value
+/// @return The old value or nil if there was no previous value.
+///
+///         @warning It may return nil if there was no previous value
+///                  or if previous value was `v:null`.
 Object buffer_set_var(Buffer buffer, String name, Object value, Error *err)
 {
   buf_T *buf = find_buffer_by_handle(buffer, err);