Add examples to the Serializer API docs #4440
Conversation
bmac
force-pushed
the
addon-serializer-docs
branch
from
24d3837
to
945ef9d
Compare
| It's injected as a service. | ||
| It can be used to push records from a non flat data structure server | ||
| response. | ||
| The `store` property is the application's `store` that contains |
There was a problem hiding this comment.
so it's a bit confusing here because you have the store passed into the function's parameter list, and also this.store, which gets set when the serializer is instantiated.
I think this documentation is for this.store because of @property, but isn't used in the example below.
bmac
force-pushed
the
addon-serializer-docs
branch
from
945ef9d
to
7b37a76
Compare
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| @method serialize | ||
| @param {DS.Model} record |
There was a problem hiding this comment.
Can you update this to be DS.Snapshot?
|
Nice writeup! 💯 👍 |
bmac
force-pushed
the
addon-serializer-docs
branch
from
7b37a76
to
49dee7f
Compare
|
@pangratz @fivetanley This pr has been updated. |
| It can be used to push records from a non flat data structure server | ||
| response. | ||
| The `store` property is the application's `store` that contains | ||
| all records. It can be used to look up serializer for other model |
There was a problem hiding this comment.
Extreme Nitpicking™️ – double space here :)
Also look up serializer for other model type => look up serializers for other model types ?
| @method serialize | ||
| @param {DS.Model} record | ||
| @param {DS.Snapshot} record |
There was a problem hiding this comment.
Should this parameter be named snapshot instead of record?
|
Sorry @wecc, GitHub didn't show up your comment when I was merging. Wanna open up a follow up PR? |
|
Planck time trolled us! 🕐 |
No description provided.