Public alerts API
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Update the following methods:
alerts_namespace:add(alert)- now returnstrue.alerts_namespace:set(key, alert)- now returnstrueif the alert
was set,falseif an alert with the same key and message already
exists.alerts_namespace:unset(key)- now returnstrueif the alert was
discarded,falseif it didn't exist.alerts_namespace:clear()- now returnstrueif any alerts were
discarded,falseif the namespace was already empty.
New method:
alerts_namespace:get(key)- returns the alert with the given key,
ornilif it doesn't exist.
Requested by @Godrik0 in https://github.com/tarantool/tarantool/commit/5879f121b2c6babaefefed81d721b83e904e3308.
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
Find the existing documentation entry for the alerts_namespace API and compare its documented methods with the requested return values. Add the get(key) method and document the true/false outcomes for add, set, unset, and clear. Done means the public API reference matches all behaviors listed in the issue.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100