From 38643668cda765e5976fab593226bbbc1a710690 Mon Sep 17 00:00:00 2001 From: Dean Brettle Date: Fri, 28 Aug 2015 16:37:53 -0700 Subject: [PATCH] Doc export from debugOnly and prodOnly packages Address lack of documentation mentioned in issue #3639. --- tools/isobuild/package-api.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tools/isobuild/package-api.js b/tools/isobuild/package-api.js index 6f9e0917bd..0094bd48a5 100644 --- a/tools/isobuild/package-api.js +++ b/tools/isobuild/package-api.js @@ -436,7 +436,11 @@ _.extend(PackageAPI.prototype, { * @instance * @summary Export package-level variables in your package. The specified * variables (declared without `var` in the source code) will be available - * to packages that use this package. + * to packages that use your package. If your package sets the `debugOnly` + * or `prodOnly` options to `true` when it calls `Package.describe()`, then + * packages that use your package will need to use + * `Package["package-name"].ExportedVariableName` to access the value of an + * exported variable. * @locus package.js * @param {String|String[]} exportedObjects Name of the object to export, or * an array of object names.