Permalink
Browse files

[docs] Updated use and to documentation to show use of function param

  • Loading branch information...
1 parent 5450c28 commit 5f9edd2bddb4296afbc7318fbb9400a905c8968f @danhumphrey danhumphrey committed Aug 24, 2012
Showing with 6 additions and 2 deletions.
  1. +6 −2 README.md
View
@@ -195,14 +195,18 @@ the attribute that was specified in the `where` clause.
```
function Map#use(key)
-@param key {String} A string that represents a key in the data object that was provided.
+@param key {String|Function} A string that represents a key in the data object that was provided or a function which returns a string value to use.
+
+If a function is provided, it will be passed data, value and tagbody parameters.
```
### to()
```
function Map#to(key)
-@param key {String} A string that represents a key in the data object that was provided.
+@param key {String|Function} A string that represents a key in the data object that was provided or a function which returns a string value to use.
+
+If a function is provided, it will be passed data, value and tagbody parameters.
Same as `use` method.
```

0 comments on commit 5f9edd2

Please sign in to comment.