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

Update docs about event in the plugin #886

Open
steinkel opened this issue Jun 16, 2020 · 2 comments
Open

Update docs about event in the plugin #886

steinkel opened this issue Jun 16, 2020 · 2 comments

Comments

@steinkel
Copy link
Member

Update event names and usage

@steinkel
Copy link
Member Author

I'd improve the documentation to add the following items to all the events:

  • Name (as we have now)
  • Why: Describe the reason for this event, add typical use cases for the event like "Useful to validate user data and update it before saving it"
  • When is it triggered: Describe when the plugin is dispatching the event
  • Preconditions: Describe any specific data passed in the event data
  • Postconditions: Describe what happens if the event is stopped, of if anything is expected in the event data

@ajibarra
Copy link
Member

@steinkel is this still valid?

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