]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): Improve docs for empty(), len(), and string() on objects
authormityu <mityu.mail@gmail.com>
Fri, 29 Mar 2024 09:14:41 +0000 (10:14 +0100)
committerChristian Brabandt <cb@256bit.org>
Fri, 29 Mar 2024 09:14:41 +0000 (10:14 +0100)
closes: #14324

Signed-off-by: mityu <mityu.mail@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/builtin.txt

index 1f7a4f1bd76e0fbc2f7ae07d334a83503baa13b5..9e57a8cc4a7148932beafc954d4b5b435a92efbc 100644 (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
@@ -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, 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()
@@ -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()