updating method documentation

lib/logging.rb

@@ -172,7 +172,28 @@ def appenders
       ::Logging::Appenders
     end
 
-    # TODO: document method
+    # call-seq:
+    #    Logging.consolidate( 'First::Name', 'Second::Name', ... )
+    #
+    # Consolidate all loggers under the given namespace. All child loggers
+    # in the namespace will use the "consolidated" namespace logger instead
+    # of creating a new logger for each class or module.
+    #
+    # If the "root" logger name is passed to this method then all loggers
+    # will consolidate to the root logger. In other words, only the root
+    # logger will be created, and it will be used by all classes and moduels
+    # in the applicaiton.
+    #
+    # ==== Example
+    #
+    #    Logging.consolidate( 'Foo' )
+    #
+    #    foo = Logging.logger['Foo']
+    #    bar = Logging.logger['Foo::Bar']
+    #    baz = Logging.logger['Baz']
+    #
+    #    foo.object_id == bar.object_id    #=> true
+    #    foo.object_id == baz.object_id    #=> false
     #
     def consolidate( *args )
       ::Logging::Repository.instance.add_master(*args)

lib/logging/repository.rb

@@ -167,7 +167,13 @@ def parent_name( key )
       p
     end
 
-    # TODO: document method
+    # call-seq:
+    #    add_master( 'First::Name', 'Second::Name', ... )
+    #
+    # Add the given logger names to the list of consolidation masters. All
+    # classes in the given namespace(s) will use these loggers instead of
+    # creating their own individual loggers.
+    #
     def add_master( *args )
       args.map do |key|
         key = to_key(key)
@@ -176,7 +182,12 @@ def add_master( *args )
       end
     end
 
-    # TODO: document method
+    # call-seq:
+    #    master_for( key )
+    #
+    # Retruns the consolidation master name for the given _key_. If there is
+    # no consolidation master, then +nil+ is returned.
+    #
     def master_for( key )
       return if @masters.empty?
       key = to_key(key)