aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJosé Valim <jose.valim@gmail.com>2011-05-25 02:17:10 -0700
committerJosé Valim <jose.valim@gmail.com>2011-05-25 02:17:10 -0700
commitb1bb9d17381c860653db50589774e83cb5c95293 (patch)
tree0ccf63578acc773359f2b849da7b806bad05a20a
parent9562c0f8998e04833737591378841b45bbf24bef (diff)
parenta984050570621cc39e898ee7926e2e200a6db9a5 (diff)
downloadrails-b1bb9d17381c860653db50589774e83cb5c95293.tar.gz
rails-b1bb9d17381c860653db50589774e83cb5c95293.tar.bz2
rails-b1bb9d17381c860653db50589774e83cb5c95293.zip
Merge pull request #1293 from janx/master
Fix Rails::Paths::Root documentation
-rw-r--r--railties/lib/rails/paths.rb7
1 files changed, 3 insertions, 4 deletions
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