From 4c86e4a580fc172b0f524a371c133d6d990022d0 Mon Sep 17 00:00:00 2001
From: matz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Mon, 31 Jul 2006 06:31:38 +0000
Subject: * lib/logger.rb: improves the amount of documentation that Rdoc  
 picks up when processing logger.rb by moving the require   statement back
 before the comment block.  a patch from Hugh   Sasse <hgs at dmu.ac.uk>. 
 [ruby-core:08422]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@10647 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/readbytes.rb | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'lib/readbytes.rb')

diff --git a/lib/readbytes.rb b/lib/readbytes.rb
index d6a3b10afe..08b92da73c 100644
--- a/lib/readbytes.rb
+++ b/lib/readbytes.rb
@@ -12,6 +12,11 @@ class TruncatedDataError<IOError
 end
 
 class IO
+  # reads exactly n bytes from the IO stream.
+  # If the data read is nil, raises EOFError.
+  # If the data read is too short, raises TruncatedDataError.
+  # The method TruncatedDataError#data may be used to obtain
+  # the truncated message.
   def readbytes(n)
     str = read(n)
     if str == nil
-- 
cgit v1.2.3