about summary refs log tree commit homepage
diff options
context:
space:
mode:
-rw-r--r--ext/kgio/read_write.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/ext/kgio/read_write.c b/ext/kgio/read_write.c
index 141b078..890392c 100644
--- a/ext/kgio/read_write.c
+++ b/ext/kgio/read_write.c
@@ -127,7 +127,9 @@ static VALUE kgio_read(int argc, VALUE *argv, VALUE io)
 
 /*
  * Same as Kgio::PipeMethods#kgio_read, except EOFError is raised
- * on EOF without a backtrace
+ * on EOF without a backtrace.  This method is intended as a
+ * drop-in replacement for places where IO#readpartial is used, and
+ * may be aliased as such.
  */
 static VALUE kgio_read_bang(int argc, VALUE *argv, VALUE io)
 {