search

gmac / backbone.epoxy

Declarative data binding and computed models for Backbone
http://epoxyjs.org
MIT License
615 stars 89 forks source link

Update documentation #14

Closed giggio closed 11 years ago

giggio commented 11 years ago

It seems some documentation might be out of date. The add binding filter example code seems to use a different signature than it is actually used now: http://epoxyjs.org/documentation.html#binding-add-filter This might be because of the library beeing updated, it would be a good idea to have this updated, as new users are going to find frustrating, not understanding why their filters are not working.

gmac commented 11 years ago

Hey, thanks for the note – I definitely apply the philosophy that a mis-documented working feature is still a bug. Ironic that you pegged the filters documentation in this report, which is the final API that I'm still locking down.

So after a quick review: the addFilter documentation does not look inaccurate, although I will admit that it's deliberately incomplete. It currently only addresses filters as a one-way function, although the library does now support two-way filtering under the hood. This is on my punch list for the v1.0 release, and those addFilter docs will definitely be updated when that two-way API is finalized.

I'm leaving this ticket open as a task item for myself to finish.

gmac commented 11 years ago

Filters have gotten a lot of attention in the 1.0 release, along with their related documentation. Closing this out.