Minor improvements for the RDoc documentation.

lib/whois.rb

@@ -30,7 +30,16 @@ module Whois
 
 
   # Queries the right whois server for <tt>qstring</tt> and returns
-  # a Whois::Answer instance containing the response from the server.
+  # a <tt>Whois::Answer</tt> instance containing the response from the server.
+  #
+  #   Whois.query("google.com")
+  #   # => #<Whois::Answer>
+  #
+  # This is equivalent to
+  #
+  #   Whois::Client.new.query("google.com")
+  #   # => #<Whois::Answer>
+  #
   def self.whois(qstring)
     query(qstring)
   end
@@ -39,11 +48,11 @@ def self.whois(qstring)
   # <tt>qstring</tt> is intended to be a domain name,
   # otherwise this method may return unexpected responses.
   #
-  # Whois.available?("google.com")
-  # # => false
-  #
-  # Whois.available?("google-is-not-available-try-again-later.com")
-  # # => true
+  #   Whois.available?("google.com")
+  #   # => false
+  #   
+  #   Whois.available?("google-is-not-available-try-again-later.com")
+  #   # => true
   #
   # Warning: this method is only available if a Whois parser exists
   # for <tt>qstring</tt> top level domain. Otherwise you'll get a warning message
@@ -63,11 +72,11 @@ def self.available?(qstring)
   # <tt>qstring</tt> is intended to be a domain name,
   # otherwise this method may return unexpected responses.
   #
-  # Whois.registered?("google.com")
-  # # => true
-  #
-  # Whois.registered?("google-is-not-available-try-again-later.com")
-  # # => false
+  #   Whois.registered?("google.com")
+  #   # => true
+  #   
+  #   Whois.registered?("google-is-not-available-try-again-later.com")
+  #   # => false
   #
   # Warning: this method is only available if a Whois parser exists
   # for <tt>qstring</tt> top level domain. Otherwise you'll get a warning message

lib/whois/answer/parser.rb

@@ -32,13 +32,16 @@ class Parser
         :nameservers,
       ]
 
+      # Returns an array containing the name of all methods
+      # that can be registered and should be implemented by
+      # server-specific parsers.
       def self.registrable_methods
         @@registrable_methods
       end
 
       attr_reader :answer
 
-   
+
       def initialize(answer)
         @answer = answer
       end

lib/whois/answer/parser/blank.rb

@@ -22,7 +22,7 @@ class Answer
     class Parser
 
       #
-      # = blank parser
+      # = Blank parser
       #
       # The Blank parser isn't a real parser. It's just a fake parser
       # that acts as a parser but doesn't provide any special capability.

lib/whois/answer/part.rb

@@ -23,9 +23,10 @@ class Answer
     #
     # = Part
     #
-    # A single answer fragment. For instance, in case of thin server,
-    # an answer may be composed by more parts corresponding
-    # to all responses returned by the whois servers.
+    # A single <tt>Whois::Answer</tt> fragment. For instance, 
+    # in case of thin server, an <tt>Whois::Answer</tt> may be composed by 
+    # one or more parts corresponding to all responses 
+    # returned by the WHOIS servers.
     #
     class Part < SuperStruct.new(:response, :host)
     end

lib/whois/client.rb

@@ -60,6 +60,12 @@ class Query # :nodoc
     end
 
 
+    # Queries the right whois server for <tt>qstring</tt> and returns
+    # a <tt>Whois::Answer</tt> instance containing the response from the server.
+    #
+    #   client.query("google.com")
+    #   # => #<Whois::Answer>
+    #
     def query(qstring)
       Timeout::timeout(timeout) do
         @server = Server.guess(qstring)

lib/whois/errors.rb

@@ -38,13 +38,13 @@ class InterfaceNotSupported < ServerError
   end
 
   # Raised when a server is known to not be available for this kind of object
-  # or because this specific object doesn't support whois. (\x03)
+  # or because this specific object doesn't support WHOIS. (\x03)
   class NoInterfaceError < InterfaceNotSupported
   end
 
   # Raised when the class has found a server but it doesn't support the
   # standard whois interface via port 43. This is the case of some
-  # specific domains that only provide a web–based whois interface. (\x01)
+  # specific domains that only provide a web–based WHOIS interface. (\x01)
   class WebInterfaceError < InterfaceNotSupported
   end
 
@@ -74,9 +74,13 @@ class ParserError < Error
   class ParserNotFound < ParserError
   end
 
+  # Raised when the property method has not been overwritten (implemented)
+  # in a child parser class.
   class PropertyNotImplemented < ParserError
   end
 
+  # Raised when you are trying to access a property that is not supported
+  # by any of the parsers available for current WHOIS answer.
   class PropertyNotSupported < ParserError
   end
 

lib/whois/server/adapters/none.rb

@@ -39,7 +39,7 @@ class None < Base
         # ==== Raises
         # NoInterfaceError:: for every request
         #
-        def request(query)
+        def request(qstring)
           raise NoInterfaceError, "This `#{type}' has no whois server"
         end
 

lib/whois/server/adapters/standard.rb

@@ -30,8 +30,8 @@ module Adapters
       #
       class Standard < Base
 
-        def request(query)
-          response = query_the_socket(query, host)
+        def request(qstring)
+          response = query_the_socket(qstring, host)
           append_to_buffer response, host
         end