string.c: Follow up to ae2359f602bb467ca755eef02d73d361d35eaed7

* Mention `\0`
* Make the example of hash replacement meaningful

1 files changed, 6 insertions, 5 deletions

diff --git a/string.c b/string.c
index aa26f35d60..154f8e98d9 100644
--- a/string.c
+++ b/string.c
@@ -11859,7 +11859,7 @@ rb_enc_interned_str_cstr(const char *ptr, rb_encoding *enc)
  *  However, you may refer to some special match variables using these
  *  combinations:
  *
- *  - <tt>\&</tt> corresponds to <tt>$&</tt>,
+ *  - <tt>\&</tt> and <tt>\0</tt> correspond to <tt>$&</tt>,
  *    which contains the complete matched text.
  *  - <tt>\'</tt> corresponds to <tt>$'</tt>,
  *    which contains string after match.
@@ -11894,11 +11894,12 @@ rb_enc_interned_str_cstr(const char *ptr, rb_encoding *enc)
  *  the replacing string is the value for that key:
  *
  *    h = {'foo' => 'bar', 'baz' => 'bat'}
- *    'food'.sub('oo', h) # => "fd"
+ *    'food'.sub('foo', h) # => "bard"
+ *
+ *  Note that a symbol key does not match:
+ *
  *    h = {foo: 'bar', baz: 'bat'}
- *    'food'.sub('oo', h) # => "fd"
- *    h = {foo: :bar, baz: :bat}
- *    'food'.sub('oo', h) # => "fd"
+ *    'food'.sub('foo', h) # => "d"
  *
  *  <b>Block</b>
  *