adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): Improve docs for empty(), len(), and string() on objects

Browse Source 
closes: #14324

Signed-off-by: mityu <mityu.mail@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
mityu
2024-03-29 10:14:41 +01:00
committed by Christian Brabandt
parent ea95f1a5ad
commit 7f0bba2595
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
runtime/doc/builtin.txt
View File

@ -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 VIM REFERENCE MANUAL by Bram Moolenaar
@ -2265,8 +2265,8 @@ empty({expr}) *empty()*
- A |Job| is empty when it failed to start. - A |Job| is empty when it failed to start.
- A |Channel| is empty when it is closed. - A |Channel| is empty when it is closed.
- A |Blob| is empty when its length is zero. - A |Blob| is empty when its length is zero.
- An |Object| is empty, when the |empty()| builtin method in - An |Object| is empty, when the empty() method in the object
the object (if present) returns true. (if present) returns true. |object-empty()|
For a long |List| this is much faster than comparing the For a long |List| this is much faster than comparing the
length with zero. length with zero.
@ -5485,9 +5485,9 @@ len({expr}) The result is a Number, which is the length of the argument.
When {expr} is a |Blob| the number of bytes is returned. When {expr} is a |Blob| the number of bytes is returned.
When {expr} is a |Dictionary| the number of entries in the When {expr} is a |Dictionary| the number of entries in the
|Dictionary| is returned. |Dictionary| is returned.
When {expr} is an |Object|, invokes the |len()| method in the When {expr} is an |Object|, invokes the len() method in the
object (if present) to get the length. Otherwise returns object (if present) to get the length (|object-len()|).
zero. Otherwise returns zero.
Can also be used as a |method|: > Can also be used as a |method|: >
mylist->len() mylist->len()
@ -9605,9 +9605,9 @@ string({expr}) Return {expr} converted to a String. If {expr} is a Number,
replaced by "[...]" or "{...}". Using eval() on the result replaced by "[...]" or "{...}". Using eval() on the result
will then fail. 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, 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|: > Can also be used as a |method|: >
mylist->string() mylist->string()