From 18bc572c20d95ab43478c1a95497d483961fb179 Mon Sep 17 00:00:00 2001 From: crandmck Date: Fri, 6 Jun 2014 10:11:46 -0700 Subject: [PATCH] Add disclaimer to JSDoc and small correction. --- index.js | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/index.js b/index.js index fc0e2ef..081a5e9 100644 --- a/index.js +++ b/index.js @@ -6,7 +6,11 @@ var addInstructionsToBrowserify = require('./lib/bundler'); /** * Initialize an application from an options object or * a set of JSON and JavaScript files. - * + * + * > **NOTE**: This module is primarily intended for use with LoopBack 2.0. + * It _does_ work with LoopBack 1.x applications, but + * none of the LoopBack 1.x examples or generated code (scaffolding) use it. + * * This function takes an optional argument that is either a string * or an object. * @@ -32,9 +36,9 @@ var addInstructionsToBrowserify = require('./lib/bundler'); * In both cases, the function loads JavaScript files in the `/models` and * `/boot` subdirectories of the application root directory with `require()`. * - * **NOTE:** mixing `app.boot()` and `app.model(name, config)` in multiple - * files may result in models being **undefined** due to race conditions. - * To avoid this when using `app.boot()` make sure all models are passed + * **NOTE:** Mixing `bootLoopBackApp(app, bootConfig)` and `app.model(name, modelConfig)` in multiple + * files may result in models being undefined due to race conditions. + * To avoid this when using `bootLoopBackApp()` make sure all models are passed * as part of the `models` definition. * * Throws an error if the config object is not valid or if boot fails.