Documenting Adapter. Fixing typo in association.rb documentation.

Scott Kobewka · Scott Kobewka · commit 7178b9de7bf0 · 2016-08-17T20:24:36.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,8 @@ Misc:
 
 - [#1878](https://github.com/rails-api/active_model_serializers/pull/1878) Cache key generation for serializers now uses `ActiveSupport::Cache.expand_cache_key` instead of `Array#join` by default and is also overridable. This change should be backward-compatible. (@markiz)
 
+- [#1799](https://github.com/rails-api/active_model_serializers/pull/1799) Add documentation for setting the adapter. (@ScottKbka)
+
 ### [v0.10.2 (2016-07-05)](https://github.com/rails-api/active_model_serializers/compare/v0.10.1...v0.10.2)
 
 Fixes:
diff --git a/docs/general/rendering.md b/docs/general/rendering.md
@@ -82,7 +82,11 @@ See [Fields](fields.md) for more information.
 
 #### adapter
 
-PR please :)
+This option lets you explicitly set the adapter to be used by passing a registered adapter. Your options are `:attributes`, `:json`, and `:json_api`.
+
+```
+ActiveModel::Serializer.config.adapter = :json_api
+```
 
 #### key_transform
 
diff --git a/lib/active_model/serializer/association.rb b/lib/active_model/serializer/association.rb
@@ -1,6 +1,6 @@
 module ActiveModel
   class Serializer
-    # This class hold all information about serializer's association.
+    # This class holds all information about serializer's association.
     #
     # @attr [Symbol] name
     # @attr [ActiveModel::Serializer] serializer

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`module ActiveModel`
`2`	`2`	`class Serializer`
`3`		`- # This class hold all information about serializer's association.`
	`3`	`+ # This class holds all information about serializer's association.`
`4`	`4`	`#`
`5`	`5`	`# @attr [Symbol] name`
`6`	`6`	`# @attr [ActiveModel::Serializer] serializer`