tarantool / tarantool/doc

Incorrect description of the trigger box.ctl.on_election

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

Nobody has claimed this yet.

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

Description

Incorrect description of the trigger box.ctl.on_election
https://www.tarantool.io/ru/doc/latest/reference/reference_lua/box_ctl/on_election/
It is written that:
The trigger doesn’t accept any parameters. You can see the changes in box.info.election and box.info.synchro.
But in reality, only changes in box.info.election are shown.
It is necessary to remove the mention of box.info.synchro.

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.

Research direction

Open the referenced box.ctl.on_election documentation page and locate the sentence describing the trigger's visible changes. Remove the mention of box.info.synchro, leaving the accurate box.info.election reference, then review the rendered page to confirm the description is correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
86/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.