From f125b79e4e952a0226d42a6e8d4a57ae8dcf982e Mon Sep 17 00:00:00 2001 From: Molly Jones Date: Tue, 17 Nov 2015 12:25:26 -0800 Subject: [PATCH] docs formatting update for new autoRestore flag --- src/service/run-api-service.js | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/src/service/run-api-service.js b/src/service/run-api-service.js index 16b7033c..1f278204 100644 --- a/src/service/run-api-service.js +++ b/src/service/run-api-service.js @@ -82,13 +82,13 @@ module.exports = function (config) { filter: '', /** - * Convenience alias for filter + * Convenience alias for filter. * @type {String} */ id: '', /** - * Flag determines if X-AutoRestore: true header is sent to Epicenter. Defaults to true. + * Flag determines if `X-AutoRestore: true` header is sent to Epicenter. Defaults to `true`. * @type {boolean} */ autoRestore: true, @@ -292,7 +292,6 @@ module.exports = function (config) { }, - //Saving data /** * Save attributes (data, model variables) of the run. * @@ -315,7 +314,6 @@ module.exports = function (config) { return http.patch(attributes, httpOptions); }, - //##Operations /** * Call a method from the model. * @@ -387,7 +385,7 @@ module.exports = function (config) { * { name: 'runmodel', params: [] }]); * * **Parameters** - * @param {Array[String]|Array[Object]} `operations` If none of the methods take parameters, pass an array of the method names (strings). If any of the methods do take parameters, pass an array of objects, each of which contains a method name and its own (possibly empty) array of parameters. + * @param {Array} `operations` If none of the methods take parameters, pass an array of the method names (strings). If any of the methods do take parameters, pass an array of objects, each of which contains a method name and its own (possibly empty) array of parameters. * @param {*} `params` Parameters to pass to operations. * @param {Object} `options` (Optional) Overrides for configuration options. */