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

Update api documents #1358

Merged
merged 1 commit into from
Apr 28, 2017
Merged

Update api documents #1358

merged 1 commit into from
Apr 28, 2017

Conversation

loay
Copy link
Contributor

@loay loay commented Apr 26, 2017

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

  • New tests added or existing tests modified to cover all changes N/A
  • Code conforms with the style
    guide

* 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo:
continuously and until

* 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo deferred

/**
* 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be a utility

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

datasource and The

* 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this even valid?

/*!
/**
...
*/

Copy link
Contributor

@raymondfeng raymondfeng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@loay loay merged commit f804663 into master Apr 28, 2017
@loay loay deleted the api-doc-2 branch April 28, 2017 03:12
@loay loay removed the #review label Apr 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants