lib/hadley/utils.rb in hadley-0.0.2 vs lib/hadley/utils.rb in hadley-0.0.3

@@ -1,9 +1,18 @@
+# This module contains a collection of generally useful methods that (currently) have no better place to live. They can 
+# either be referenced directly as module methods or be mixed in. 
 module Hadley::Utils
   extend self
 
-  def camelize(word, uc_first=true)
-    parts = word.split('_')
+  # This method will derive a camelized name from the provided underscored name.
+  # 
+  # @param [#to_s] name The underscored name to be camelized.
+  # @param [Boolean] uc_first True if and only if the first letter of the resulting camelized name should be 
+  #  capitalized.
+  #
+  # @return [String] The camelized name corresponding to the provided underscored name.
+  def camelize(name, uc_first=true)
+    parts = name.to_s.split('_')
     assemble = lambda { |head, tail| head + tail.capitalize }
     uc_first ? parts.inject('', &assemble) : parts.inject(&assemble)
   end
 
 end