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

Fix meta_key/meta documentation

Browse Source 
This updates the documentation to reflect the behavior implemented by
the v0.9.x series. Note that this behavior differs from that of the
v0.8.x series, which is reflected by the current documentation.

Consideration should be given to patching the v0.9.x series to revert
back to the v0.8.x behavior since I'm not entirely sure if this slight
change was intentional, but for the time being, this at least documents
the existing behavior correctly.
This commit is contained in:
Craig Little 2014-09-03 14:02:57 -07:00
parent 605408005f
commit e9008439d3
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -354,7 +354,7 @@ The above usage of `:meta` will produce the following:
If you would like to change the meta key name you can use the `:meta_key` option:
```ruby
render json: @posts, serializer: CustomArraySerializer, meta: {total: 10}, meta_key: 'meta_object'
render json: @posts, serializer: CustomArraySerializer, meta_object: {total: 10}, meta_key: 'meta_object'
```
The above usage of `:meta_key` will produce the following: