Project

General

Profile

Bug #17364 » string_encode_docs.diff

tjschuck (T.J. Schuck), 12/03/2020 08:38 PM

View differences:

transcode.c
/*
* call-seq:
* str.encode!(encoding [, options] ) -> str
* str.encode!(dst_encoding, src_encoding [, options] ) -> str
* str.encode!(encoding, **options) -> str
* str.encode!(dst_encoding, src_encoding, **options) -> str
*
* The first form transcodes the contents of <i>str</i> from
* str.encoding to +encoding+.
* The second form transcodes the contents of <i>str</i> from
* src_encoding to dst_encoding.
* The options Hash gives details for conversion. See String#encode
* The +options+ keyword arguments give details for conversion. See String#encode
* for details.
* Returns the string even if no changes were made.
*/
......
/*
* call-seq:
* str.encode(encoding [, options] ) -> str
* str.encode(dst_encoding, src_encoding [, options] ) -> str
* str.encode([options]) -> str
* str.encode(encoding, **options) -> str
* str.encode(dst_encoding, src_encoding, **options) -> str
* str.encode(**options) -> str
*
* The first form returns a copy of +str+ transcoded
* to encoding +encoding+.
......
* in the source encoding. The last form by default does not raise
* exceptions but uses replacement strings.
*
* The +options+ Hash gives details for conversion and can have the following
* keys:
* The +options+ keyword arguments give details for conversion.
* The arguments are:
*
* :invalid ::
* If the value is +:replace+, #encode replaces invalid byte sequences in
(3-3/3)