Warn about event handlers
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
At work we stumbled upon this: https://stackoverflow.com/questions/25443327
Which basically means: when editing an object its container does also gets notified about it, which could (depending on the event handler) cause a massive performance problem (let's say that you build some expensive pdfs, graphs, trigger reindexes or what not).
I guess that would be nice to let everyone know about it when reading the event handlers documentation, so here probably: https://5.docs.plone.org/develop/addons/components/events.html
Will try to send a pull request, no promise on it though (lack of time anyone? :S)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the event handlers documentation at https://5.docs.plone.org/develop/addons/components/events.html and read the surrounding explanation. Add a clear warning that editing an object also notifies its container, including the possible performance impact of expensive event handlers; done means this behavior and risk are visible to readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100