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

Typo in README #171

Open
sfrooster opened this issue Dec 30, 2021 · 3 comments
Open

Typo in README #171

sfrooster opened this issue Dec 30, 2021 · 3 comments

Comments

@sfrooster
Copy link

I'll submit a PR if no one gets to this before I do.

This page - and possibly others - indicate the "New FSM" event emitted by the top-level "machina" has an event name of newfsm (all lower-case), but the code shows the actual event name to be newFsm (capital 'F'). A minor detail, but....

@sfrooster
Copy link
Author

Immediately after submitting this, I realized I hadn't reported the issue quite right. At either the top "machina" level or within a B/Fsm, there are two ways to designate a handler for an emitted event:

  • through the "eventListeners" property
  • by specifying a handler using the "on" property

Looking at things now, it appears the code is expecting the to "machina" level to emit newfsm and it's only machina.eventListeners which is set to expect newFsm

@ifandelse
Copy link
Owner

Thanks for giving me a heads up on this @sfrooster. I've been working on an updated machina repo (in another branch) as well as a full replacement for the docs branch, and I'll look at getting this fixed (initially w/o breaking backwards compat) as part of that.

@sfrooster
Copy link
Author

sfrooster commented Jan 3, 2022 via email

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