Merge pull request #15646 from aditya-kapoor/correct-conversion-docs

[ci skip] correct docs for conversion
This commit is contained in:
Zachary Scott 2014-06-11 11:32:50 -07:00
commit eec571f992

@ -40,13 +40,15 @@ def to_model
self
end
# Returns an Enumerable of all key attributes if any is set, regardless if
# Returns an Array of all key attributes if any is set, regardless if
# the object is persisted or not. Returns +nil+ if there are no key attributes.
#
# class Person < ActiveRecord::Base
# class Person
# include ActiveModel::Conversion
# attr_accessor :id
# end
#
# person = Person.create
# person = Person.create(id: 1)
# person.to_key # => [1]
def to_key
key = respond_to?(:id) && id
@ -56,10 +58,15 @@ def to_key
# Returns a +string+ representing the object's key suitable for use in URLs,
# or +nil+ if <tt>persisted?</tt> is +false+.
#
# class Person < ActiveRecord::Base
# class Person
# include ActiveModel::Conversion
# attr_accessor :id
# def persisted?
# true
# end
# end
#
# person = Person.create
# person = Person.create(id: 1)
# person.to_param # => "1"
def to_param
(persisted? && key = to_key) ? key.join('-') : nil