From bf3b507791403811bece9dff915ca10757bca519 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 28 Oct 2010 21:02:31 +0000 Subject: expand Kgio::*#kgio_read! documentation If the author can forget why it was written, so can the rest of the world. --- ext/kgio/read_write.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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) { -- cgit v1.2.3-24-ge0c7