[DOC release] Improve Ember.deprecate documentation

asakusuma · Aug 4, 2016 · ddd7f58 · ddd7f58
1 parent 3d25f98
commit ddd7f58
Showing 1 changed file with 10 additions and 7 deletions.
diff --git a/packages/ember-debug/lib/deprecate.js b/packages/ember-debug/lib/deprecate.js
@@ -103,13 +103,16 @@ export let missingOptionsUntilDeprecation = 'When calling `Ember.deprecate` you
 
   @method deprecate
   @param {String} message A description of the deprecation.
-  @param {Boolean} test A boolean. If falsy, the deprecation
-    will be displayed.
-  @param {Object} options An object that can be used to pass
-    in a `url` to the transition guide on the emberjs.com website, and a unique
-    `id` for this deprecation. The `id` can be used by Ember debugging tools
-    to change the behavior (raise, log or silence) for that specific deprecation.
-    The `id` should be namespaced by dots, e.g. "view.helper.select".
+  @param {Boolean} test A boolean. If falsy, the deprecation will be displayed.
+  @param {Object} options
+  @param {String} options.id A unique id for this deprecation. The id can be
+    used by Ember debugging tools to change the behavior (raise, log or silence)
+    for that specific deprecation. The id should be namespaced by dots, e.g.
+    "view.helper.select".
+  @param {string} options.until The version of Ember when this deprecation
+    warning will be removed.
+  @param {String} [options.url] An optional url to the transition guide on the
+    emberjs.com website.
   @for Ember
   @public
 */