From e9008439d3e44fb4a97513b6b11a3d2ffcb0875f Mon Sep 17 00:00:00 2001 From: Craig Little Date: Wed, 3 Sep 2014 14:02:57 -0700 Subject: [PATCH] Fix meta_key/meta documentation 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. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fbcf9152..44b12bd8 100644 --- a/README.md +++ b/README.md @@ -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: