From 635349fb86b3058d7e3e083c7270805681628b5c Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Fri, 4 Aug 2006 18:05:50 +0000
Subject: Documentation cleanup.

Includes patches by Hugh Sasse:
* ping.rb
* weakref.rb
* mailread.rb


git-svn-id: http://svn.ruby-lang.org/repos/ruby/trunk@10668 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/readbytes.rb | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'lib/readbytes.rb')

diff --git a/lib/readbytes.rb b/lib/readbytes.rb
index 08b92da73..ebb5fc0bd 100644
--- a/lib/readbytes.rb
+++ b/lib/readbytes.rb
@@ -1,22 +1,22 @@
-# readbytes.rb
-#
-# add IO#readbytes, which reads fixed sized data.
-# it guarantees read data size.
+# TruncatedDataError is raised when IO#readbytes fails to read enough data.
 
 class TruncatedDataError<IOError
-  def initialize(mesg, data)
+  def initialize(mesg, data) # :nodoc:
     @data = data
     super(mesg)
   end
+
+  # The read portion of an IO#readbytes attempt.
   attr_reader :data
 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.
+  # Reads exactly +n+ bytes.
+  #
+  # If the data read is nil an EOFError is raised.
+  #
+  # If the data read is too short a TruncatedDataError is raised and the read
+  # data is obtainable via its #data method.
   def readbytes(n)
     str = read(n)
     if str == nil
-- 
cgit