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 documentation for rich inputs #4

Open
exarkun opened this issue Apr 17, 2014 · 1 comment
Open

add documentation for rich inputs #4

exarkun opened this issue Apr 17, 2014 · 1 comment

Comments

@exarkun
Copy link
Member

exarkun commented Apr 17, 2014

The "rich input" and "input context" ideas in machinist aren't implementations of a very common or widely used concept in the "finite state machine" sphere (though they are certainly inspired by ideas I saw in other libraries). The current documentation doesn't really explain them well enough for anyone to know how they work or why they're useful.

Add some docs explaining them. Probably with an example or two.

@exarkun
Copy link
Member Author

exarkun commented May 15, 2014

There is some overlap here with #3, likely, which also discusses an example for rich inputs. There's probably room for more than one - but examples aren't the only kind of documentation machinist should have. A little prose that explains why the heck there is even such a thing as "rich inputs" would be pretty handy.

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

1 participant