Documentation of model vs. instance methods. #687
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
…save future explorers some digging.
Codecov Report
@@ Coverage Diff @@
## master #687 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 47 47
Lines 1554 1554
Branches 260 260
=========================================
Hits 1554 1554 Continue to review full report at Codecov.
|
cuebit
requested changes
May 10, 2021
| You may insert new data or update existing data through various Model methods. All data created through Vuex ORM gets persisted to Vuex Store. | ||
| You may insert new data or update existing data through various Model methods. All data created through Vuex ORM gets persisted to Vuex Store. | ||
|
|
||
| Model methods are defined as both class methods (`Model.update`) and as instance methods (`modelInstance.$update`). These methods have identical behavior except for utilizing a different source for the object ID (passed parameter vs. object instance). |
There was a problem hiding this comment.
This should read "defined as both static methods..." since "class methods" could be recognised as static or instance (more often the latter).
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.
Adding clarification in Guide between Model and Instance methods, to save future explorers some digging.
Type of PR:
Breaking changes:
Details
Adding a bit of documentation on model methods vs instance methods, since it took me a little digging to find out the difference.