No docs on SC.Statechart

Question

No docs on SC.Statechart

Opened this issue 11 years ago · 3 comments

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.

Answer 1 · 2013-09-29T15:18:35.000Z

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.

Answer 2 · 2013-09-29T15:21:05.000Z

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!

Answer 3 · 2013-09-29T15:24:41.000Z

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