ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-23 06:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2090 from mikekellyio/patch-1

Browse Source 
Reword ActiveModelSerializer::Model docs for clarity
This commit is contained in:
Benjamin Fleischer 2017-03-29 08:50:14 -05:00 committed by GitHub
commit 04125a06b0
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lib/active_model_serializers/model.rb
View File

@ -6,7 +6,7 @@ module ActiveModelSerializers
include ActiveModel::Serializers::JSON include ActiveModel::Serializers::JSON
include ActiveModel::Model include ActiveModel::Model
# Declare names of attributes to be included in +sttributes+ hash. # Declare names of attributes to be included in +attributes+ hash.
# Is only available as a class-method since the ActiveModel::Serialization mixin in Rails # Is only available as a class-method since the ActiveModel::Serialization mixin in Rails
# uses an +attribute_names+ local variable, which may conflict if we were to add instance methods here. # uses an +attribute_names+ local variable, which may conflict if we were to add instance methods here.
# #
@ -19,8 +19,8 @@ module ActiveModelSerializers
# Easily declare instance attributes with setters and getters for each. # Easily declare instance attributes with setters and getters for each.
# #
# All attributes to initialize an instance must have setters. # To initialize an instance, all attributes must have setters.
# However, the hash turned by +attributes+ instance method will ALWAYS # However, the hash returned by +attributes+ instance method will ALWAYS
# be the value of the initial attributes, regardless of what accessors are defined. # be the value of the initial attributes, regardless of what accessors are defined.
# The only way to change the change the attributes after initialization is # The only way to change the change the attributes after initialization is
# to mutate the +attributes+ directly. # to mutate the +attributes+ directly.
@ -58,7 +58,7 @@ module ActiveModelSerializers
# Override the +attributes+ method so that the hash is derived from +attribute_names+. # Override the +attributes+ method so that the hash is derived from +attribute_names+.
# #
# The the fields in +attribute_names+ determines the returned hash. # The fields in +attribute_names+ determines the returned hash.
# +attributes+ are returned frozen to prevent any expectations that mutation affects # +attributes+ are returned frozen to prevent any expectations that mutation affects
# the actual values in the model. # the actual values in the model.
def attributes def attributes