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

Add tutorial-style documentation for building a very basic state machine #13

Open
glyph opened this issue May 14, 2014 · 2 comments
Open
Labels

Comments

@glyph
Copy link

glyph commented May 14, 2014

The example doesn't import and as per #11 and #4 it isn't even correct.

There is no narrative documentation beyond the README, and while the blog posts generally explain the motivation for using state machines, they don't cover how to make good use of machinist very well.

@exarkun
Copy link
Member

exarkun commented May 15, 2014

Thanks. This is an accurate description of the (unarguably lamentable) current state of affairs. However, I don't find that it usefully encapsulates a piece of work to be done on machinist.

Could you imagine that #3 and #4 are resolved already and describe what further documentation would be of use?

Thanks again.

@glyph
Copy link
Author

glyph commented May 15, 2014

I suppose I was filing this intentionally as a broader issue than the lack of one particular bit of documentation. If either #3 or #4 were addressed, then there would technically be some documentation, so this issue would thereby be solved, so the summary was not very good :-).

What I was actually hoping for when I filed this was actually a tutorial, some kind of overarching structure for the documentation; #3 sounds like just an example and #4 sounds reference material. I guess it depends what you had in mind?

@exarkun exarkun changed the title there is effectively no documentation Add tutorial-style documentation for building a very basic state machine May 15, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants