]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): Tweak documentation about base64 function
authorh-east <h.east.727@gmail.com>
Thu, 2 Jan 2025 09:40:29 +0000 (10:40 +0100)
committerChristian Brabandt <cb@256bit.org>
Thu, 2 Jan 2025 09:42:07 +0000 (10:42 +0100)
closes: #16353

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

index 9d010150a6a6574b6f934aaaa8fa854ae2cd7caa..48ba03b8bdac142e980eda4cc07e330bf9996bd0 100644 (file)
@@ -1,4 +1,4 @@
-*builtin.txt*  For Vim version 9.1.  Last change: 2024 Dec 31
+*builtin.txt*  For Vim version 9.1.  Last change: 2025 Jan 02
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -67,8 +67,8 @@ autocmd_get([{opts}])         List    return a list of autocmds
 balloon_gettext()              String  current text in the balloon
 balloon_show({expr})           none    show {expr} inside the balloon
 balloon_split({msg})           List    split {msg} as used for a balloon
-base64_decode({string})                Blob    base-64 decode {string} characters
-base64_encode({blob})          String  base-64 encode the bytes in {blob}
+base64_decode({string})                Blob    base64 decode {string} characters
+base64_encode({blob})          String  base64 encode the bytes in {blob}
 bindtextdomain({package}, {path})
                                Bool    bind text domain to specified path
 blob2list({blob})              List    convert {blob} into a list of numbers
@@ -1171,43 +1171,6 @@ autocmd_get([{opts}])                                    *autocmd_get()*
                Return type: list<dict<any>>
 
 
-base64_decode({string})                                        *base64_decode()*
-               Return a Blob containing the bytes decoded from the base64
-               characters in {string}.
-
-               The {string} argument should contain only base64-encoded
-               characters and should have a length that is a multiple of 4.
-
-               Returns an empty blob on error.
-
-               Examples: >
-                   " Write the decoded contents to a binary file
-                   call writefile(base64_decode(s), 'tools.bmp')
-                   " Decode a base64-encoded string
-                   echo list2str(blob2list(base64_decode(encodedstr)))
-<
-               Can also be used as a |method|: >
-                       GetEncodedString()->base64_decode()
-<
-               Return type: |Blob|
-
-
-base64_encode({blob})                                  *base64_encode()*
-               Return a base64-encoded String representing the bytes in
-               {blob}.  The base64 alphabet defined in RFC 4648 is used.
-
-               Examples: >
-                   " Encode the contents of a binary file
-                   echo base64_encode(readblob('somefile.bin'))
-                   " Encode a string
-                   echo base64_encode(list2blob(str2list(somestr)))
-<
-               Can also be used as a |method|: >
-                       GetBinaryData()->base64_encode()
-<
-               Return type: |String|
-
-
 balloon_gettext()                                      *balloon_gettext()*
                Return the current text in the balloon.  Only for the string,
                not used for the List.  Returns an empty string if balloon
@@ -1264,6 +1227,43 @@ balloon_split({msg})                                     *balloon_split()*
 
                Return type: list<any> or list<string>
 
+base64_decode({string})                                        *base64_decode()*
+               Return a Blob containing the bytes decoded from the base64
+               encoded characters in {string}.
+
+               The {string} argument should contain only base64-encoded
+               characters and should have a length that is a multiple of 4.
+
+               Returns an empty blob on error.
+
+               Examples: >
+                   " Write the decoded contents to a binary file
+                   call writefile(base64_decode(s), 'tools.bmp')
+                   " Decode a base64-encoded string
+                   echo list2str(blob2list(base64_decode(encodedstr)))
+<
+               Can also be used as a |method|: >
+                       GetEncodedString()->base64_decode()
+<
+               Return type: |Blob|
+
+
+base64_encode({blob})                                  *base64_encode()*
+               Return a base64-encoded String representing the bytes in
+               {blob}.  The base64 alphabet defined in RFC 4648 is used.
+
+               Examples: >
+                   " Encode the contents of a binary file
+                   echo base64_encode(readblob('somefile.bin'))
+                   " Encode a string
+                   echo base64_encode(list2blob(str2list(somestr)))
+<
+               Can also be used as a |method|: >
+                       GetBinaryData()->base64_encode()
+<
+               Return type: |String|
+
+
 bindtextdomain({package}, {path})                      *bindtextdomain()*
                Bind a specific {package} to a {path} so that the
                |gettext()| function can be used to get language-specific