search

sproutcore / docs

The documentation source. Build and push to https://github.com/sproutcore-docs/sproutcore-docs.github.com.
http://docs.sproutcore.com
MIT License
14 stars 8 forks source link

No docs on SC.Statechart #6

Open MFKoelmans opened 10 years ago

MFKoelmans commented 10 years ago

I wanted to look up an instance variable of SC.Statechart on sproutcore.com, but it turned out it isn't on the list of classes.

dcporter commented 10 years ago

This is confusing – SC.Statechart is actually documented under SC.StatechartManager, here. The reason for that is that all of the statechart behavior is actually a mixin that you can also drop into views for some very cool handling of sophisticated behavior.

dcporter commented 10 years ago

This could be fixed by adding some documentation to SC.Statechart itself (defined almost offhandedly at the bottom of the StatechartManager code page here). Even just a note to see SC.StatechartManager (and why) would help. This is one of our standout features, and it's impossible to find the documentation!

MFKoelmans commented 10 years ago

Thanks! I started reading it and noted an interesting typo: heircharies. While not a native speaker, I think this ought to be 'hierarchies'.