Skip to content

Commit

Permalink
runtime(doc): Improve docs for empty(), len(), and string() on objects
Browse files Browse the repository at this point in the history
closes: #14324

Signed-off-by: mityu <mityu.mail@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
  • Loading branch information
mityu authored and chrisbra committed Mar 29, 2024
1 parent ea95f1a commit 7f0bba2
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions 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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 |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()
Expand Down Expand Up @@ -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
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()
Expand Down

0 comments on commit 7f0bba2

Please sign in to comment.