Document `box.txn_id()`
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Document box.txn_id()
Product: Tarantool
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/reference_capi/txn/
SME: @
Peer reviewer: @
Details
New function in module box: box.txn_id(), which returns the id of the current
transaction if called within a transaction, nil otherwise.
Requested by @AnastasMIPT in https://github.com/tarantool/tarantool/commit/2763a7f64a590aece865f9ffbdf287eec95c49fd.
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 transaction API section at the linked root document. Document box.txn_id() and its behavior: return the current transaction ID inside a transaction and nil otherwise. Done means the function is covered in the Tarantool documentation with this behavior clearly stated.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100