Document that EventListeners must be listen'd on #90
Conversation
In retrospect it is sometimes unclear in the documentation that the new event listener needs to be pinned and inserted into the list before it can receive events. This PR adds documentation that should clarify this issue. Closes #89 Signed-off-by: John Nunley <dev@notgull.net>
notgull
changed the title
There was a problem hiding this comment.
Thanks for the quick action here and adding such detailed docs! 👍 However, apart from the nit comment, I think we should also at least change the API (in a compatible way) to either add a new new method that doesn't take a Event ref and deprecate new or (if possible) make listen() implicit in the first time EventListener is polled and deprecate EventListener::listen. I'd very much prefer the latter, since it removes the footgun.
I created #91 for this part so you can ignore this comment here. |
Signed-off-by: John Nunley <dev@notgull.net>
In retrospect it is sometimes unclear in the documentation that the new event listener needs to be pinned and inserted into the list before it can receive events. This PR adds documentation that should clarify this issue.
Closes #89
cc @zeenix