From 8aafb3d33d55130ef40946958f629e269d007bfe Mon Sep 17 00:00:00 2001 From: Carlos Antonio da Silva Date: Wed, 24 Apr 2013 20:51:15 -0300 Subject: Review DatabaseTasks docs [ci skip] --- .../lib/active_record/tasks/database_tasks.rb | 34 +++++++++++----------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/activerecord/lib/active_record/tasks/database_tasks.rb b/activerecord/lib/active_record/tasks/database_tasks.rb index 019fb62152..8d0792f750 100644 --- a/activerecord/lib/active_record/tasks/database_tasks.rb +++ b/activerecord/lib/active_record/tasks/database_tasks.rb @@ -9,29 +9,29 @@ module ActiveRecord # The tasks defined here are used in rake tasks provided by Active Record. # # In order to use DatabaseTasks, a few config values need to be set. All the needed - # config values are set by rails already, so it's necessary to do it only if you - # want to change the default or when you want to use Active Record outside of Rails - # (in such case after cofniguring database tasks, you can also use rake tasks defined in - # Active Record) + # config values are set by Rails already, so it's necessary to do it only if you + # want to change the defaults or when you want to use Active Record outside of Rails + # (in such case after configuring the database tasks, you can also use the rake tasks + # defined in Active Record). # # - # The possible config values are the following: + # The possible config values are: # - # * env: current environment - # * db_dir: your 'db' directory - # * seed_loader: an object which will load seeds, it needs to respond to `load_seed` method - # * database_configuration: configuration of your databases (as in config/database.yml) - # * migrations_paths: a list of paths to directories with migrations - # * fixtures_path: a path to fixtures directory + # * +env+: current environment (like Rails.env). + # * +database_configuration+: configuration of your databases (as in +config/database.yml+). + # * +db_dir+: your +db+ directory. + # * +fixtures_path+: a path to fixtures directory. + # * +migrations_paths+: a list of paths to directories with migrations. + # * +seed_loader+: an object which will load seeds, it needs to respond to the +load_seed+ method. # - # Example usage of DatabaseTasks outside Rails could look as such: + # Example usage of +DatabaseTasks+ outside Rails could look as such: # - # include ActiveRecord::Tasks - # DatabaseTasks.database_configuration = YAML.load(File.read('my_database_config.yml')) - # DatabaseTasks.db_dir = 'db' - # # other settings... + # include ActiveRecord::Tasks + # DatabaseTasks.database_configuration = YAML.load(File.read('my_database_config.yml')) + # DatabaseTasks.db_dir = 'db' + # # other settings... # - # DatabaseTasks.create_current('production') + # DatabaseTasks.create_current('production') module DatabaseTasks extend self -- cgit v1.2.3