summaryrefslogtreecommitdiff
path: root/doc/string
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2023-01-16 19:44:40 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2023-01-16 19:44:40 +0900
commita2748c500d776fe0386271b4458fa3fd1c0dd56d (patch)
treee0eefcf06309ba51a88dea16c9d5a7d3f0ce861a /doc/string
parent11f28f3268f9234b6310bc659de7e46dfc5c0706 (diff)
downloadruby-a2748c500d776fe0386271b4458fa3fd1c0dd56d.tar.gz
[DOC] Update `String#encode` special case
This behavior has been slightly extended with the addition of `String#scrub`.
Diffstat (limited to 'doc/string')
-rw-r--r--doc/string/encode.rdoc9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/string/encode.rdoc b/doc/string/encode.rdoc
index a7d400724d..65872fdfd4 100644
--- a/doc/string/encode.rdoc
+++ b/doc/string/encode.rdoc
@@ -39,8 +39,9 @@ interprets +self+ using +src_encoding+, encodes the new string using +dst_encodi
Optional keyword arguments +enc_opts+ specify encoding options;
see {Encoding Options}[rdoc-ref:encodings.rdoc@Encoding+Options].
-Please note that conversion from an encoding +enc+ to the same encoding
-+enc+ (independent of whether +enc+ is given explicitly or implicitly)
-is a no-op, i.e. the string is simply copied without any changes, and
-no exceptions are raised, even if there are invalid bytes.
+Please note that, unless <code>invalid: :replace</code> option is
+given, conversion from an encoding +enc+ to the same encoding +enc+
+(independent of whether +enc+ is given explicitly or implicitly) is a
+no-op, i.e. the string is simply copied without any changes, and no
+exceptions are raised, even if there are invalid bytes.