From a984050570621cc39e898ee7926e2e200a6db9a5 Mon Sep 17 00:00:00 2001
From: Jan Xie <jan.h.xie@gmail.com>
Date: Wed, 25 May 2011 16:38:51 +0800
Subject: fix Rails::Paths::Root document

---
 railties/lib/rails/paths.rb | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

(limited to 'railties')

diff --git a/railties/lib/rails/paths.rb b/railties/lib/rails/paths.rb
index e9b5042f60..09ff0ef378 100644
--- a/railties/lib/rails/paths.rb
+++ b/railties/lib/rails/paths.rb
@@ -6,7 +6,7 @@ module Rails
     # It allows you to collect information about how you want to structure your application
     # paths by a Hash like API. It requires you to give a physical path on initialization.
     #
-    #   root = Root.new
+    #   root = Root.new "/rails"
     #   root.add "app/controllers", :eager_load => true
     #
     # The command above creates a new root object and add "app/controllers" as a path.
@@ -36,8 +36,7 @@ module Rails
     #
     # Finally, the Path object also provides a few helpers:
     #
-    #   root = Root.new
-    #   root.path = "/rails"
+    #   root = Root.new "/rails"
     #   root.add "app/controllers"
     #
     #   root["app/controllers"].expanded # => ["/rails/app/controllers"]
@@ -48,7 +47,7 @@ module Rails
       attr_accessor :path
 
       def initialize(path)
-        raise if path.is_a?(Array)
+        raise "Argument should be a String of the physical root path" if path.is_a?(Array)
         @current = nil
         @path = path
         @root = self
-- 
cgit v1.2.3