Public alerts API

Open Beginner friendly
#5,692 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
documentation

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.

Description

Update the following methods:

  • alerts_namespace:add(alert) - now returns true.
  • alerts_namespace:set(key, alert) - now returns true if the alert
    was set, false if an alert with the same key and message already
    exists.
  • alerts_namespace:unset(key) - now returns true if the alert was
    discarded, false if it didn't exist.
  • alerts_namespace:clear() - now returns true if any alerts were
    discarded, false if the namespace was already empty.

New method:

Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tarantool/doc

All issues in tarantool/doc

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.