Datasource documentation tune-up #1333
Merged
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
kjdelisle
changed the title
kjdelisle
force-pushed
the
api-doc-refactor
branch
from
1fcf7d2
to
3197131
Compare
kjdelisle
force-pushed
the
api-doc-refactor
branch
2 times, most recently
from
6ef1988
to
9f8648c
Compare
|
@raymondfeng When you're feeling better, please take a look at the comments marked Once this portion is complete, I'll move onto tuning up the corresponding juggler documentation in loopback.io |
kjdelisle
force-pushed
the
api-doc-refactor
branch
from
9f8648c
to
199a9a4
Compare
raymondfeng
reviewed
Apr 24, 2017
lib/datasource.js
Outdated
| * @param callback | ||
| * @returns {Promise} | ||
| * @emits connect |
There was a problem hiding this comment.
The event name is connected.
raymondfeng
reviewed
Apr 24, 2017
lib/datasource.js
Outdated
| * Define relations for the model class from the relations object | ||
| * @param modelClass | ||
| * @param relations | ||
| /** |
There was a problem hiding this comment.
IIRC, we intentionally use /*! to not expose this method to generated API references.
raymondfeng
reviewed
Apr 24, 2017
lib/datasource.js
Outdated
| @@ -731,23 +745,35 @@ DataSource.prototype.mixin = function(ModelCtor) { | |||
| }; | |||
|
|
|||
| /** | |||
| * See ModelBuilder.getModel | |||
| * | |||
| * // XXX(kev): Deprecation notice for 4.x? | |||
There was a problem hiding this comment.
Do we want to use a generic tag, such as // REVIEW or // FIXME?
kjdelisle
force-pushed
the
api-doc-refactor
branch
from
199a9a4
to
4ba4752
Compare
loay
force-pushed
the
api-doc-refactor
branch
2 times, most recently
from
fcc7257
to
47497f3
Compare
raymondfeng
reviewed
Apr 25, 2017
lib/datasource.js
Outdated
| @@ -949,7 +990,7 @@ DataSource.prototype.autoupdate = function(models, cb) { | |||
| * @property {Boolean} views If true, include views; if false, only tables. | |||
| * @property {Number} limit Page size | |||
| * @property {Number} offset Starting index | |||
| * | |||
| * @returns {Model[]} | |||
There was a problem hiding this comment.
We should use ModelDefinition[] to differentiate from Model which is for the mode class.
raymondfeng
reviewed
Apr 25, 2017
lib/datasource.js
Outdated
| * The synchronous version of discoverModelDefinitions. | ||
| * @options {Object} options The options | ||
| * @property {Boolean} all If true, discover all models; if false, discover only models owned by the current user. | ||
| * @property {Boolean} views If true, nclude views; if false, only tables. | ||
| * @property {Number} limit Page size | ||
| * @property {Number} offset Starting index | ||
| * @returns {*} | ||
| * @returns {Model[]} |
|
@loay Don't forget to squash and rename the commits to remove "wip" |
loay
changed the title
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.
connected to https://github.com/strongloop-internal/scrum-apex/issues/175