runtime(doc): Tweak documentation about base64 function
Commit:
https://github.com/vim/vim/commit/e80f345b5dbc0ef3186d640e3d5adb7fcdfef64c
Author: h-east <h.east....@gmail.com>
Date: Thu Jan 2 10:40:29 2025 +0100
runtime(doc): Tweak documentation about base64 function
closes: https://github.com/vim/vim/issues/16353
Signed-off-by: Christian Brabandt <c...@256bit.org>
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 9d010150a..48ba03b8b 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -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
--
--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php
---
You received this message because you are subscribed to the Google Groups
"vim_dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to vim_dev+unsubscr...@googlegroups.com.
To view this discussion visit
https://groups.google.com/d/msgid/vim_dev/E1tTHlL-002OLv-Aa%40256bit.org.
