martin/emacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify base64 requirements and say what {en,de}code_coding_region does

Browse Source 
* src/coding.c (Fencode_coding_region): Clarify what this does.
(Fdecode_coding_region): Ditto.

* src/fns.c (Fbase64_decode_region): Clarify that this function
returns bytes, not text (bug#38587).
(Fbase64_encode_region): Clarify that this function takes bytes,
not text.
This commit is contained in:
Lars Ingebrigtsen
2019-12-24 17:11:04 +01:00
parent 6184aa003f
commit 0de63092c8
2 changed files with 28 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/coding.c
View File

@@ -9415,6 +9415,13 @@ code_convert_region (Lisp_Object start, Lisp_Object end,
DEFUN ("decode-coding-region", Fdecode_coding_region, Sdecode_coding_region,
3, 4, "r\nzCoding system: ",
doc: /* Decode the current region from the specified coding system.
What's meant by \"decoding\" is transforming bytes into text
(characters). If, for instance, you have a region that contains data
that represents the two bytes #xc2 #xa9, after calling this function
with the utf-8 coding system, the region will contain the single
character ?\\N{COPYRIGHT SIGN}.
When called from a program, takes four arguments:
START, END, CODING-SYSTEM, and DESTINATION.
START and END are buffer positions.
@@ -9438,6 +9445,13 @@ not fully specified.) */)
DEFUN ("encode-coding-region", Fencode_coding_region, Sencode_coding_region,
3, 4, "r\nzCoding system: ",
doc: /* Encode the current region by specified coding system.
What's meant by \"encoding\" is transforming textual data (characters)
into bytes. If, for instance, you have a region that contains the
single character ?\\N{COPYRIGHT SIGN}, after calling this function with
the utf-8 coding system, the data in the region will represent the two
bytes #xc2 #xa9.
When called from a program, takes four arguments:
START, END, CODING-SYSTEM and DESTINATION.
START and END are buffer positions.