aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorghodss2013-08-11 16:03:17 -0700
committerBrian Ford2013-08-22 10:59:29 -0700
commit3d70e55d725288e9a1fcec22d95ba3a075f57e7c (patch)
treef180649fe0d199ab93389a8317088a189b4dff0b
parentdbcc44dc80644e4390523ab33204b460f60648ec (diff)
downloadangular.js-3d70e55d725288e9a1fcec22d95ba3a075f57e7c.tar.bz2
docs(guide): warn about module creation versus retrieval
Updated Module documentation to include the suggestion of the top-rated comment: "This documentation should warn that "angular.module('myModule', [])" always creates a new module, but "angular.module('myModule')" always retrieves an existing reference."
-rw-r--r--docs/content/guide/module.ngdoc18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/content/guide/module.ngdoc b/docs/content/guide/module.ngdoc
index a1c02546..8bf0eba6 100644
--- a/docs/content/guide/module.ngdoc
+++ b/docs/content/guide/module.ngdoc
@@ -191,6 +191,24 @@ scripts into a VM. There are existing projects which deal with script loading, w
with Angular. Because modules do nothing at load time they can be loaded into the VM in any order
and thus script loaders can take advantage of this property and parallelize the loading process.
+## Creation versus Retrieval
+
+Beware that using `angular.module('myModule', [])` will create the module `myModule` and overwrite any
+existing module named `myModule`. Use `angular.module('myModule')` to retrieve an existing module.
+
+<pre>
+ var myModule = angular.module('myModule', []);
+
+ // add some directives and services
+ myModule.service('myService', ...);
+ myModule.directive('myDirective', ...);
+
+ // overwrites both myService and myDirective by creating a new module
+ var myModule = angular.module('myModule', []);
+
+ // throws an error because myOtherModule has yet to be defined
+ var myModule = angular.module('myOtherModule');
+</pre>
# Unit Testing