docs:include: improve docs

IgorMinar · IgorMinar · commit 86ff9dee2376 · 2011-06-30T11:33:36.000-07:00
diff --git a/src/widgets.js b/src/widgets.js
@@ -806,12 +806,13 @@ angularWidget('select', function(element){
  * @name angular.widget.ng:include
  *
  * @description
- * Include external HTML fragment.
+ * Fetches, compiles and includes an external HTML fragment.
  *
  * Keep in mind that Same Origin Policy applies to included resources
  * (e.g. ng:include won't work for file:// access).
  *
- * @param {string} src expression evaluating to URL.
+ * @param {string} src angular expression evaluating to URL. If the source is a string constant,
+ *                 make sure you wrap it in quotes, e.g. `src="'myPartialTemplate.html'"`.
  * @param {Scope=} [scope=new_child_scope] optional expression which evaluates to an
  *                 instance of angular.scope to set the HTML fragment to.
  * @param {string=} onload Expression to evaluate when a new partial is loaded.

Original file line number	Diff line number	Diff line change
`@@ -806,12 +806,13 @@ angularWidget('select', function(element){`
`806`	`806`	`* @name angular.widget.ng:include`
`807`	`807`	`*`
`808`	`808`	`* @description`
`809`		`- * Include external HTML fragment.`
	`809`	`+ * Fetches, compiles and includes an external HTML fragment.`
`810`	`810`	`*`
`811`	`811`	`* Keep in mind that Same Origin Policy applies to included resources`
`812`	`812`	`* (e.g. ng:include won't work for file:// access).`
`813`	`813`	`*`
`814`		`- * @param {string} src expression evaluating to URL.`
	`814`	`+ * @param {string} src angular expression evaluating to URL. If the source is a string constant,`
	`815`	+ * make sure you wrap it in quotes, e.g. `src="'myPartialTemplate.html'"`.
`815`	`816`	`* @param {Scope=} [scope=new_child_scope] optional expression which evaluates to an`
`816`	`817`	`* instance of angular.scope to set the HTML fragment to.`
`817`	`818`	`* @param {string=} onload Expression to evaluate when a new partial is loaded.`