Mercurial > vim
changeset 34694:009989ec3ff6
runtime(doc): Improve docs for empty(), len(), and string() on objects
Commit: https://github.com/vim/vim/commit/7f0bba25952cd0d1b3b4a8f9fb51fa6085d3bd13
Author: mityu <mityu.mail@gmail.com>
Date: Fri Mar 29 10:14:41 2024 +0100
runtime(doc): Improve docs for empty(), len(), and string() on objects
closes: https://github.com/vim/vim/issues/14324
Signed-off-by: mityu <mityu.mail@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Fri, 29 Mar 2024 10:30:03 +0100 |
| parents | 5092488d28d6 |
| children | 5569220366ee |
| files | runtime/doc/builtin.txt |
| diffstat | 1 files changed, 8 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -1,4 +1,4 @@ -*builtin.txt* For Vim version 9.1. Last change: 2024 Mar 28 +*builtin.txt* For Vim version 9.1. Last change: 2024 Mar 29 VIM REFERENCE MANUAL by Bram Moolenaar @@ -2265,8 +2265,8 @@ empty({expr}) *empty()* - A |Job| is empty when it failed to start. - A |Channel| is empty when it is closed. - A |Blob| is empty when its length is zero. - - An |Object| is empty, when the |empty()| builtin method in - the object (if present) returns true. + - An |Object| is empty, when the empty() method in the object + (if present) returns true. |object-empty()| For a long |List| this is much faster than comparing the length with zero. @@ -5485,9 +5485,9 @@ len({expr}) The result is a Number, whic When {expr} is a |Blob| the number of bytes is returned. When {expr} is a |Dictionary| the number of entries in the |Dictionary| is returned. - When {expr} is an |Object|, invokes the |len()| method in the - object (if present) to get the length. Otherwise returns - zero. + When {expr} is an |Object|, invokes the len() method in the + object (if present) to get the length (|object-len()|). + Otherwise returns zero. Can also be used as a |method|: > mylist->len() @@ -9605,9 +9605,9 @@ string({expr}) Return {expr} converted t replaced by "[...]" or "{...}". Using eval() on the result will then fail. - For an object, invokes the |string()| method to get a textual + For an object, invokes the string() method to get a textual representation of the object. If the method is not present, - then the default representation is used. + then the default representation is used. |object-string()| Can also be used as a |method|: > mylist->string()