Update api documents #1358
Merged
Update api documents #1358
Conversation
This file contains hidden or 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
0candy
suggested changes
Apr 26, 2017
lib/datasource.js
Outdated
| * REVIEW: Raymond, can you give example of what behavior(s) are typically | ||
| * expected here? I understand that it's connector-specific, but surely there's | ||
| * a common goal here. | ||
| * To continouly add artifacts to datasource untill it is frozen, but it is not really used in loopback. |
There was a problem hiding this comment.
typo:
continuously and until
lib/datasource.js
Outdated
| * REVIEW: What is "obj" supposed to represent? | ||
| * @param {Object} obj ? | ||
| * @param {Object} args ? | ||
| * @param {Object} obj Defered method call if the connector is not fully connected yet |
lib/datasource.js
Outdated
| /** | ||
| * Define a hidden property | ||
| * REVIEW: Why is a hidden property not writable or enumerable? What | ||
| * purpose does it serve? | ||
| * It is an ulitlity to define a property to the Object with info flags |
0candy
suggested changes
Apr 27, 2017
lib/datasource.js
Outdated
| @@ -806,14 +804,15 @@ DataSource.prototype.supportTypes = function(types) { | |||
| } | |||
| }; | |||
|
|
|||
| /*! In future versions, this will not maintain a strict 1:1 relationship between datasources and model classes | |||
| /*! Moving forward, we will allow a model to be attached to a datsource. the model itself becomes a template. | |||
0candy
approved these changes
Apr 27, 2017
raymondfeng
reviewed
Apr 27, 2017
| * See [ModelBuilder.getModel](http://apidocs.strongloop.com/loopback-datasource-juggler/#modelbuilder-prototype-getmodel) | ||
| * for details. | ||
| */ | ||
| DataSource.prototype.getModel = function(name, forceCreate) { | ||
| return this.modelBuilder.getModel(name, forceCreate); | ||
| }; | ||
|
|
||
| /*! Method will be deprecated in LoopBack.next |
There was a problem hiding this comment.
Is this even valid?
/*!
/**
...
*/
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.
Description
Update api documents/ js docs and address all REVIEW and FIXME tags
Related issues
connect to https://github.com/strongloop-internal/scrum-apex/issues/175
Checklist
guide