Update the docs for normalizeModelName so they explain the intent of …

…the function
emberjs · Aug 26, 2016 · bf28602 · bf28602
1 parent 79c81a5
commit bf28602
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/addon/-private/system/normalize-model-name.js b/addon/-private/system/normalize-model-name.js
@@ -1,12 +1,16 @@
 import Ember from 'ember';
 
+// All modelNames are dasherized internally. Changing this function may
+// require changes to other normalization hooks (such as typeForRoot).
+
 /**
-  All modelNames are dasherized internally. Changing this function may
-  require changes to other normalization hooks (such as typeForRoot).
+ This method normalizes a modelName into the format Ember Data uses
+ internally.
+
   @method normalizeModelName
   @public
   @param {String} modelName
-  @return {String} if the adapter can generate one, an ID
+  @return {String} normalizedModelName
   @for DS
 */
 export default function normalizeModelName(modelName) {