* io.c (rb_io_putc): documentation updated to mention putc would

  not work well with multi-byte characters.  [ruby-core:30697]

* io.c (rb_f_putc): ditto.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28243 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 8 insertions, 3 deletions

diff --git a/io.c b/io.c
index d010f38374..e293728847 100644
--- a/io.c
+++ b/io.c
@@ -6012,9 +6012,11 @@ rb_f_print(int argc, VALUE *argv)
  *  call-seq:
  *     ios.putc(obj)    -> obj
  *
- *  If <i>obj</i> is <code>Numeric</code>, write the character whose
- *  code is <i>obj</i>, otherwise write the first character of the
- *  string representation of  <i>obj</i> to <em>ios</em>.
+ *  If <i>obj</i> is <code>Numeric</code>, write the character whose code is
+ *  the least-significant byte of <i>obj</i>, otherwise write the first byte
+ *  of the string representation of <i>obj</i> to <em>ios</em>. Note: This
+ *  method is not safe for use with multi-byte characters as it will truncate
+ *  them.
  *
  *     $stdout.putc "A"
  *     $stdout.putc 65
@@ -6040,6 +6042,9 @@ rb_io_putc(VALUE io, VALUE ch)
  *  Equivalent to:
  *
  *    $stdout.putc(int)
+ * 
+ * Refer to the documentation for IO#putc for important information regarding
+ * multi-byte characters.
  */
 
 static VALUE