tarantool / tarantool/doc

[2pt] Administrator’s guide: incorrect code example

Open
#2,616 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Product: Cartridge
Audience/target: admin
Root document: https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_admin/
SME: @ filonenko-mikhail


<…>ewer tuples. Below is the code in Lua:
fiber = require('fiber')
|-- define a function that will modify the function test_replace(tuple)|
-- add a timestamp to each tuple in the space
t<…>

https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_admin/#resolving-conflicts

Incorrect code example: the function is not defined.
Need to add the function definition and double-check if the entire example is correct and consistent.

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 Cartridge administrator's guide at the provided root document and inspect the resolving-conflicts section. Review the Lua example around test_replace(tuple), add the missing function definition, and verify that the complete example is correct and consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.