Browse files

Merge pull request #1293 from janx/master

Fix Rails::Paths::Root documentation
  • Loading branch information...
2 parents 9562c0f + a984050 commit b1bb9d17381c860653db50589774e83cb5c95293 @josevalim josevalim committed May 25, 2011
Showing with 3 additions and 4 deletions.
  1. +3 −4 railties/lib/rails/paths.rb
View
7 railties/lib/rails/paths.rb
@@ -6,7 +6,7 @@ module Paths
# 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 Paths
#
# 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 @@ class Root < ::Hash
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

0 comments on commit b1bb9d1

Please sign in to comment.