summaryrefslogtreecommitdiff
path: root/transcode.c
diff options
context:
space:
mode:
authorJeremy Evans <code@jeremyevans.net>2020-12-03 12:47:34 -0800
committerJeremy Evans <code@jeremyevans.net>2020-12-03 12:47:34 -0800
commit9195310168fa43186b1918fb0432a54b000fcbba (patch)
tree78b4e2d43baf1f2b34e5de40ee5254bea363edc7 /transcode.c
parent88bb1a672c49746972f4b15410fa92e9d237c43d (diff)
Update documentation for String#encode{,!} [ci skip]
These methods take keywords, not a hash. From tjschuck (T.J. Schuck) Fixes [Bug #17364]
Diffstat (limited to 'transcode.c')
-rw-r--r--transcode.c16
1 files changed, 8 insertions, 8 deletions
diff --git a/transcode.c b/transcode.c
index 3a37c63987..5bae646d05 100644
--- a/transcode.c
+++ b/transcode.c
@@ -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