From 3302391ac73d3ffed3b96dbd5736d3b9ce9c7eb2 Mon Sep 17 00:00:00 2001 From: "sghung@ca.ibm.com" Date: Thu, 17 Mar 2016 23:55:12 -0400 Subject: [PATCH 1/2] Fix inconsistencies in JSDoc --- lib/persisted-model.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/persisted-model.js b/lib/persisted-model.js index 5dceeec0..85840f68 100644 --- a/lib/persisted-model.js +++ b/lib/persisted-model.js @@ -87,7 +87,7 @@ module.exports = function(registry) { /** * Create new instance of Model, and save to database. * - * @param {Object}|[{Object}] data Optional data argument. Can be either a single model instance or an array of instances. + * @param {Object|Array.} [data] Optional data argument. Can be either a single model instance or an array of instances. * * @callback {Function} callback Callback function called with `cb(err, obj)` signature. * @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object). @@ -924,8 +924,8 @@ module.exports = function(registry) { * @param {Object} [options.filter] Replicate models that match this filter * @callback {Function} [callback] Callback function called with `(err, conflicts)` arguments. * @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object). - * @param {Conflict[]} conflicts A list of changes that could not be replicated due to conflicts. - * @param {Object] checkpoints The new checkpoints to use as the "since" + * @param {Array.} conflicts A list of changes that could not be replicated due to conflicts. + * @param {Object} checkpoints The new checkpoints to use as the "since" * argument for the next replication. */ From d69ab1e4118b309612f99f9bdc155ef4ab42cb0d Mon Sep 17 00:00:00 2001 From: "sghung@ca.ibm.com" Date: Fri, 1 Apr 2016 14:00:01 -0400 Subject: [PATCH 2/2] Update JSDoc --- lib/persisted-model.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/persisted-model.js b/lib/persisted-model.js index 85840f68..9de785e0 100644 --- a/lib/persisted-model.js +++ b/lib/persisted-model.js @@ -87,7 +87,7 @@ module.exports = function(registry) { /** * Create new instance of Model, and save to database. * - * @param {Object|Array.} [data] Optional data argument. Can be either a single model instance or an array of instances. + * @param {Object|Object[]} [data] Optional data argument. Can be either a single model instance or an array of instances. * * @callback {Function} callback Callback function called with `cb(err, obj)` signature. * @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object). @@ -924,7 +924,7 @@ module.exports = function(registry) { * @param {Object} [options.filter] Replicate models that match this filter * @callback {Function} [callback] Callback function called with `(err, conflicts)` arguments. * @param {Error} err Error object; see [Error object](http://docs.strongloop.com/display/LB/Error+object). - * @param {Array.} conflicts A list of changes that could not be replicated due to conflicts. + * @param {Conflict[]} conflicts A list of changes that could not be replicated due to conflicts. * @param {Object} checkpoints The new checkpoints to use as the "since" * argument for the next replication. */