diff options
author | Eric Wong <e@yhbt.net> | 2010-10-28 21:02:31 +0000 |
---|---|---|
committer | Eric Wong <e@yhbt.net> | 2010-10-28 21:02:31 +0000 |
commit | bf3b507791403811bece9dff915ca10757bca519 (patch) | |
tree | 98118024186e0d3fb0a7e4d330636dd1809a6e58 | |
parent | f4d08a07a02393cca5ddd1277acc4f95c83307ff (diff) | |
download | kgio-bf3b507791403811bece9dff915ca10757bca519.tar.gz |
If the author can forget why it was written, so can the rest of the world.
-rw-r--r-- | ext/kgio/read_write.c | 4 |
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) { |