Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

copy edits [ci skip]

  • Loading branch information...
commit 7663149f72b5dba15a8e850e4072a016341e541c 1 parent c78b431
@vijaydev vijaydev authored
View
34 activerecord/lib/active_record/relation/finder_methods.rb
@@ -11,11 +11,11 @@ module FinderMethods
# Person.find([1]) # returns an array for the object with ID = 1
# Person.where("administrator = 1").order("created_on DESC").find(1)
#
- # NOTE: An RecordNotFound will be raised if one or more ids are not returned.
+ # <tt>ActiveRecord::RecordNotFound</tt> will be raised if one or more ids are not found.
#
- # NOTE: that returned records may not be in the same order as the ids you
- # provide since database rows are unordered. Give an explicit <tt>order</tt>
- # to ensure the results are sorted.
+ # NOTE: The returned records may not be in the same order as the ids you
+ # provide since database rows are unordered. You'd need to provide an explicit <tt>order</tt>
+ # option if you want the results are sorted.
#
# ==== Find with lock
#
@@ -34,34 +34,30 @@ module FinderMethods
# ==== Variations of +find+
#
# Person.where(name: 'Spartacus', rating: 4)
- # # returns a chainable list (which can be empty)
+ # # returns a chainable list (which can be empty).
#
# Person.find_by(name: 'Spartacus', rating: 4)
- # # returns the first item or nil
+ # # returns the first item or nil.
#
# Person.where(name: 'Spartacus', rating: 4).first_or_initialize
- # # returns the first item or returns a new instance (requires you call .save to persist against the database)
+ # # returns the first item or returns a new instance (requires you call .save to persist against the database).
#
# Person.where(name: 'Spartacus', rating: 4).first_or_create
- # # returns the first item or creates it and returns it, available since rails 3.2.1
+ # # returns the first item or creates it and returns it, available since Rails 3.2.1.
#
- #
# ==== Alternatives for +find+
#
# Person.where(name: 'Spartacus', rating: 4).exists?(conditions = :none)
- # # returns true or false
+ # # returns a boolean indicating if any record with the given conditions exist.
#
# Person.where(name: 'Spartacus', rating: 4).select("field1, field2, field3")
- # # returns a chainable list of instances with only the mentioned fields
+ # # returns a chainable list of instances with only the mentioned fields.
#
# Person.where(name: 'Spartacus', rating: 4).ids
- # # returns an Array of ids, available since rails 3.2.1
+ # # returns an Array of ids, available since Rails 3.2.1.
#
# Person.where(name: 'Spartacus', rating: 4).pluck(:field1, :field2)
- # # returns an Array of the required fields, available since rails 3.1
- #
- # Person.arel_table
- # # returns an instance of <tt>Arel::Table</tt>, which allows a comprehensive variety of filters
+ # # returns an Array of the required fields, available since Rails 3.1.
def find(*args)
if block_given?
to_a.find { |*block_args| yield(*block_args) }
@@ -118,9 +114,9 @@ def take!
#
# Person.first # SELECT "people".* FROM "people" LIMIT 1
#
- # NOTE: Rails 3 may not +order+ this query by be the primary key.
- # The order will depend on the database implementation.
- # In order to ensure that behavior use <tt>User.order(:id).first</tt> instead.
+ # NOTE: Rails 3 may not order this query by the primary key and the order
+ # will depend on the database implementation. In order to ensure that behavior,
+ # use <tt>User.order(:id).first</tt> instead.
#
# ==== Rails 4
#
View
20 guides/source/migrations.md
@@ -366,26 +366,24 @@ create_join_table :products, :categories
which creates a `categories_products` table with two columns called
`category_id` and `product_id`. These columns have the option `:null` set to
-`false` by default.
-
-You can pass the option `:table_name` with you want to customize the table
-name. For example,
+`false` by default. This can be overridden by specifying the `:column_options`
+option.
```ruby
-create_join_table :products, :categories, table_name: :categorization
+create_join_table :products, :categories, column_options: {null: true}
```
-will create a `categorization` table.
+will create the `product_id` and `category_id` with the `:null` option as
+`true`.
-For the two table columns, you can override the default `:null` option, or add
-others, by specifying the `:column_options` option. For example,
+You can pass the option `:table_name` with you want to customize the table
+name. For example,
```ruby
-create_join_table :products, :categories, column_options: {null: true}
+create_join_table :products, :categories, table_name: :categorization
```
-will create the `product_id` and `category_id` with the `:null` option as
-`true`.
+will create a `categorization` table.
`create_join_table` also accepts a block, which you can use to add indices
(which are not created by default) or additional columns:
View
3  guides/source/rails_on_rack.md
@@ -273,10 +273,9 @@ Much of Action Controller's functionality is implemented as Middlewares. The fol
* Runs the prepare callbacks before serving the request.
-
**`ActiveRecord::Migration::CheckPending`**
-* Checks pending migrations and raise an error if migrations are pending.
+* Checks pending migrations and raises `ActiveRecord::PendingMigrationError` if any migrations are pending.
**`ActiveRecord::ConnectionAdapters::ConnectionManagement`**
View
4 guides/source/testing.md
@@ -767,8 +767,8 @@ Rake Tasks for Running your Tests
You don't need to set up and run your tests by hand on a test-by-test basis. Rails comes with a number of commands to help in testing. The table below lists all commands that come along in the default Rakefile when you initiate a Rails project.
-| Tasks | Description |
-| ------------------------ | ----------- |
+| Tasks | Description |
+| ----------------------- | ----------- |
| `rake test` | Runs all unit, functional and integration tests. You can also simply run `rake test` as Rails will run all the tests by default|
| `rake test:controllers` | Runs all the controller tests from `test/controllers`|
| `rake test:functionals` | Runs all the functional tests from `test/controllers`, `test/mailers`, and `test/functional`|
Please sign in to comment.
Something went wrong with that request. Please try again.