docs($parse): document function argument types, fix minor typo

This commit is contained in:
Daniel Luz 2012-11-04 20:36:35 -02:00 committed by Misko Hevery
parent 6092291bd7
commit 6cf9ede88e

View file

@ -840,9 +840,10 @@ function getterFn(path, csp) {
* @param {string} expression String expression to compile. * @param {string} expression String expression to compile.
* @returns {function(context, locals)} a function which represents the compiled expression: * @returns {function(context, locals)} a function which represents the compiled expression:
* *
* * `context`: an object against which any expressions embedded in the strings are evaluated * * `context` `{object}` an object against which any expressions embedded in the strings
* against (Topically a scope object). * are evaluated against (tipically a scope object).
* * `locals`: local variables context object, useful for overriding values in `context`. * * `locals` `{object=}` local variables context object, useful for overriding values in
* `context`.
* *
* The return function also has an `assign` property, if the expression is assignable, which * The return function also has an `assign` property, if the expression is assignable, which
* allows one to set values to expressions. * allows one to set values to expressions.