search

jashkenas / backbone

Give your JS App some Backbone with Models, Views, Collections, and Events
http://backbonejs.org
MIT License
28.09k stars 5.39k forks source link

Improve documentation #2492

Closed gibatronic closed 11 years ago

gibatronic commented 11 years ago

Hey guys, Backbone has a really great documentation but there's some stuff that were forgotten! Like the model set method, there's nowhere saying which options I can pass, that sucks!

Another thing is the events, I never know what events a model or collection can fire unless I browse every single method that it has. It'd be good to have a table describing which situations each event is fired.

jashkenas commented 11 years ago

Like the model set method, there's nowhere saying which options I can pass

Ha. We actually recently took that particular bit of documentation out. The only built-in option you can pass is silent, which is highly discouraged. Mostly its for passing custom options which will be forwarded along to all of your event handlers -- so use it as you see fit. This should indeed be documented better here, and not just in the section on events.

It'd be good to have a table describing which situations each event is fired.

Like this one? http://backbonejs.org/#Events-catalog

gibatronic commented 11 years ago

Oh my bad, I didn't saw that gorgeous catalog of events, that was exactly what I was looking for! Well, thanks! You guys made an awesome project, I really enjoy working with Backbone!