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

1 files changed, 4 insertions, 1 deletions

diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 09d5f1b6f8..dcae08d24c 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -336,7 +336,10 @@ Object vim_get_var(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 if any
+/// @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 vim_set_var(String name, Object value, Error *err)
 {
   return dict_set_value(&globvardict, name, value, false, err);