Mention that triggers are guaranteed to throw an error or log it
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): https://github.com/tarantool/tarantool/issues/9309
Product: Tarantool
Since: 3.1
Root document: not yet created (https://github.com/tarantool/doc/issues/3988)
SME: @ drewdzzz
Details
Now all triggers are either have a direct impact on the execution flow
(e.g. close a connection or throw an error) or print a message to error
log when they throw an error.
We have a separate entry for triggers in Tarantool documentation, which
lists the properties of the triggers - I think it's a perfect place for
this new property.
Requested by @ drewdzzz in https://github.com/tarantool/tarantool/commit/2adfc66216fd56f8e75907b0f00ca13b33bfaa9c.
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
Start with the existing Tarantool documentation entry for triggers, using development issue #9309 and the requested root document issue #3988 for context. Add the property stating that triggers affect execution flow or log errors when they throw, and confirm the trigger properties section clearly reflects this guarantee.
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
- 45/100