kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Update documentation for String#encode{,!} [ci skip]

Browse source 
These methods take keywords, not a hash.

From tjschuck (T.J. Schuck)

Fixes [Bug #17364]
This commit is contained in:
Jeremy Evans 2020-12-03 12:47:34 -08:00
parent 88bb1a672c
commit 9195310168
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
transcode.c
View file

@ -2784,14 +2784,14 @@ str_encode_associate(VALUE str, int encidx)
/*
* 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.
*/
@ -2820,9 +2820,9 @@ static VALUE encoded_dup(VALUE newstr, VALUE str, int encidx);
/*
* 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+.
@ -2838,8 +2838,8 @@ static VALUE encoded_dup(VALUE newstr, VALUE str, int encidx);
* 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