diff options
author | Yves Senn <yves.senn@gmail.com> | 2015-07-08 12:16:16 +0200 |
---|---|---|
committer | Yves Senn <yves.senn@gmail.com> | 2015-10-14 17:40:00 +0200 |
commit | 428d47adfed8d6aa7b21aec2bf5ad890961c9de3 (patch) | |
tree | 901a6d81b548940860083d762191496d671d5ad1 /activerecord/lib/active_record/tasks | |
parent | 809fd2b2737424762663dbebdc54e6ee5493df90 (diff) | |
download | rails-428d47adfed8d6aa7b21aec2bf5ad890961c9de3.tar.gz rails-428d47adfed8d6aa7b21aec2bf5ad890961c9de3.tar.bz2 rails-428d47adfed8d6aa7b21aec2bf5ad890961c9de3.zip |
applies new doc guidelines to Active Record.
The focus of this change is to make the API more accessible.
References to method and classes should be linked to make it easy to
navigate around.
This patch makes exzessiv use of `rdoc-ref:` to provide more readable
docs. This makes it possible to document `ActiveRecord::Base#save` even
though the method is within a separate module
`ActiveRecord::Persistence`. The goal here is to bring the API closer to
the actual code that you would write.
This commit only deals with Active Record. The other gems will be
updated accordingly but in different commits. The pass through Active
Record is not completely finished yet. A follow up commit will change
the spots I haven't yet had the time to update.
/cc @fxn
Diffstat (limited to 'activerecord/lib/active_record/tasks')
-rw-r--r-- | activerecord/lib/active_record/tasks/database_tasks.rb | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/activerecord/lib/active_record/tasks/database_tasks.rb b/activerecord/lib/active_record/tasks/database_tasks.rb index 39da32d65b..ea7927a435 100644 --- a/activerecord/lib/active_record/tasks/database_tasks.rb +++ b/activerecord/lib/active_record/tasks/database_tasks.rb @@ -5,7 +5,7 @@ module ActiveRecord class DatabaseAlreadyExists < StandardError; end # :nodoc: class DatabaseNotSupported < StandardError; end # :nodoc: - # <tt>ActiveRecord::Tasks::DatabaseTasks</tt> is a utility class, which encapsulates + # ActiveRecord::Tasks::DatabaseTasks is a utility class, which encapsulates # logic behind common tasks used to manage database and migrations. # # The tasks defined here are used with Rake tasks provided by Active Record. @@ -26,7 +26,7 @@ module ActiveRecord # * +seed_loader+: an object which will load seeds, it needs to respond to the +load_seed+ method. # * +root+: a path to the root of the application. # - # 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('my_database_config.yml') |