diff --git a/activerecord/lib/active_record/relation/query_methods.rb b/activerecord/lib/active_record/relation/query_methods.rb index aab7b793b9861..49e01d5e7b77a 100644 --- a/activerecord/lib/active_record/relation/query_methods.rb +++ b/activerecord/lib/active_record/relation/query_methods.rb @@ -1074,12 +1074,18 @@ def none! # :nodoc: where!("1=0").extending!(NullRelation) end - # Sets readonly attributes for the returned relation. If value is - # true (default), attempting to update a record will result in an error. + # Mark a relation as readonly. Attempting to update a record will result in + # an error. # # users = User.readonly # users.first.save # => ActiveRecord::ReadOnlyRecord: User is marked as readonly + # + # To make a readonly relation writable, pass +false+. + # + # users.readonly(false) + # users.first.save + # => true def readonly(value = true) spawn.readonly!(value) end