Added documentation to modify the hash by reference when working with serializeIntoHash
#3660
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -988,6 +988,7 @@ var JSONSerializer = Serializer.extend({ | |||
| the payload and just sends the raw serialized JSON object. | |||
| If your server expects namespaced keys, you should consider using the RESTSerializer. | |||
| Otherwise you can override this method to customize how the record is added to the hash. | |||
| The hash property should be modified by reference (possibly using something like _.extend) | |||
There was a problem hiding this comment.
I like this addition to the docs but I'd prefer to see "(possibly using something like _.extend)" removed. "possibly using something like" doesn't fit the "voice" of the docs.
There was a problem hiding this comment.
Agreed, just a first pass. Let me commit and smash
|
ping @rtablada. Do you have time to update this pr? |
|
This pr was merged as 63e9432 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When working with
serializeIntoHashif you want to modify the hash with a full set of other results, you are forced to either overwrite each individual key OR use something like_.extendto modify thehashargument in place using pass by reference.This is a common use case when creating adapters for APIs that do not have a rootKey (though strongly discouraged).
I think this addition (or something to the effect should be added to make sure that this functionality is documented.