Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No docs on SC.Statechart #6

Open
MFKoelmans opened this issue Sep 29, 2013 · 3 comments
Open

No docs on SC.Statechart #6

MFKoelmans opened this issue Sep 29, 2013 · 3 comments

Comments

@MFKoelmans
Copy link

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
Copy link
Member

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
Copy link
Member

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants