From fe9773414a29317ac8fa6c0c911bb88eb2819f40 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Sat, 2 Nov 2013 18:32:08 -0700 Subject: Move documentation around a bit --- activerecord/lib/active_record/enum.rb | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'activerecord/lib/active_record/enum.rb') diff --git a/activerecord/lib/active_record/enum.rb b/activerecord/lib/active_record/enum.rb index ef7ccb89bd..d6d1a8c9a2 100644 --- a/activerecord/lib/active_record/enum.rb +++ b/activerecord/lib/active_record/enum.rb @@ -2,10 +2,7 @@ module ActiveRecord # Declare an enum attribute where the values map to integers in the database, but can be queried by name. Example: # # class Conversation < ActiveRecord::Base - # enum status: [:active, :archived] - # - # # same but with explicit mapping - # enum status: {active: 0, archived: 1} + # enum status: [ :active, :archived ] # end # # Conversation::STATUS # => { active: 0, archived: 1 } @@ -30,6 +27,12 @@ module ActiveRecord # end # # Good practice is to let the first declared status be the default. + # + # Finally, it's also possible to explicitly map the relation between attribute and database integer: + # + # class Conversation < ActiveRecord::Base + # enum status: { active: 0, archived: 1 } + # end module Enum def enum(definitions) definitions.each do |name, values| -- cgit v1.2.3