Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[QUEST] Fix Gaps in Documentation #5756

Closed
2 of 9 tasks
anlumo opened this issue Nov 22, 2018 · 2 comments
Closed
2 of 9 tasks

[QUEST] Fix Gaps in Documentation #5756

anlumo opened this issue Nov 22, 2018 · 2 comments
Labels
🏷️ doc This PR adds/improves/or fixes documentation

Comments

@anlumo
Copy link

anlumo commented Nov 22, 2018

As requested by @runspired, here are the things I found to be undocumented, but required to be known for using ember-data:

  • snapshot, as passed into many DS.Adapter functions.
  • type, as passed into many DS.Adapter functions.
  • The meta object given to the function passed to the functions DS.Model.eachRelationship and DS.Model.eachAttribute.
  • How to notify the store about a record deletion from the server side.
  • DS.belongsTo and DS.hasMany being async by default.
  • When to use unloadRecord.
  • How to unset attributes in a way that they revert back to the defaultValue instead of null.
  • A full step-by-step guide on how to implement the whole ember-data layer with a custom adapter that does not inherit from DS.JSONAdapter (including serializers).
  • The undocumented fact that you have to push all changes that happened locally back to the store once they're on the server

Related: #4375

@runspired runspired changed the title Missing Documentation [QUEST] Fix Gaps in Documentation May 14, 2019
@runspired
Copy link
Contributor

@anlumo working on getting lots of doc fixes resource, just wanted to say thanks for opening this ♥️

@runspired
Copy link
Contributor

Going to roll this into #8394

@runspired runspired added 🏷️ doc This PR adds/improves/or fixes documentation and removed Documentation labels Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ doc This PR adds/improves/or fixes documentation
Projects
None yet
Development

No branches or pull requests

2 participants