Skip to content

Commit ae29e24

Browse files
committed
Missing piece to fixing Polymer#3094
Update the documentation in the actual dom-repeat element.
1 parent 00b6c96 commit ae29e24

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/lib/template/dom-repeat.html

+6-5
Original file line numberDiff line numberDiff line change
@@ -159,11 +159,12 @@
159159
},
160160

161161
/**
162-
* A function that can be used to filter items out of the view. This
163-
* property should either be provided as a string, indicating a method
164-
* name on the element's host, or else be an actual function. The
165-
* function should match the sort function passed to `Array.filter`.
166-
* Using a filter function has no effect on the underlying `items` array.
162+
* `filter`. Specifies a filter callback function, that takes a single
163+
* argument (the item) and returns true to display the item, false to omit
164+
* it. Using a filter callback has no effect on the underlying `items`
165+
* array.
166+
* (Note that this is **similar** to the standard `Array`
167+
* [`filter`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter) API, but the callback only takes a single argument.)
167168
*/
168169
filter: {
169170
type: Function,

0 commit comments

Comments
 (0)