From f07e7f75e949a902e50ba3f9e72e6053f6ac1a42 Mon Sep 17 00:00:00 2001 From: Joseph Spencer Date: Sat, 2 Aug 2014 01:52:18 -0700 Subject: [PATCH] Clarifying the meaning of @ in paramDefaults --- src/ngResource/resource.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/ngResource/resource.js b/src/ngResource/resource.js index 9eecb0771c20..938703e4423f 100644 --- a/src/ngResource/resource.js +++ b/src/ngResource/resource.js @@ -106,8 +106,10 @@ function shallowClearAndCopy(src, dst) { * Given a template `/path/:verb` and parameter `{verb:'greet', salutation:'Hello'}` results in * URL `/path/greet?salutation=Hello`. * - * If the parameter value is prefixed with `@` then the value of that parameter will be taken - * from the corresponding key on the data object (useful for non-GET operations). + * If the parameter value is prefixed with `@` then the value for that parameter will be extracted + * from the corresponding property on the data object (provided when calling an action method). For + * example, if the defaultParam object is `{someParam: '@someProp'}` then the value of someParam will + * be `data.someProp`. * * @param {Object.=} actions Hash with declaration of custom action that should extend * the default set of resource actions. The declaration should be created in the format of {@link