diff options
| author | ZyX <kp-pav@yandex.ru> | 2016-03-17 23:31:31 +0300 |
|---|---|---|
| committer | ZyX <kp-pav@yandex.ru> | 2016-04-18 02:48:20 +0300 |
| commit | 25bb08dad930a975010798c592b5277d1b5a18b0 (patch) | |
| tree | 077797d0f8b0aba6ba35a989da646dc36becd5b2 /src/nvim/api/vim.c | |
| parent | 4f8b6864350c3aac5427103e27c856d1782b1be1 (diff) | |
| download | rneovim-25bb08dad930a975010798c592b5277d1b5a18b0.tar.gz rneovim-25bb08dad930a975010798c592b5277d1b5a18b0.tar.bz2 rneovim-25bb08dad930a975010798c592b5277d1b5a18b0.zip | |
api: Add warnings about the returned value to \*del_var functions
Diffstat (limited to 'src/nvim/api/vim.c')
| -rw-r--r-- | src/nvim/api/vim.c | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index dcae08d24c..10110b0f62 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -349,7 +349,10 @@ Object vim_set_var(String name, Object value, Error *err) /// /// @param name The variable name /// @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_del_var(String name, Error *err) { return dict_set_value(&globvardict, name, NIL, true, err); |