document 4 more symbols in public C API
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
box_info_lsn
box_is_ro
box_ro_reason
box_wait_ro
Their meaning is identical to lua methods:
box.info.lsn
box.info.ro
box.info.ro_reason
box.wait_ro
Requested by @alyapunov in https://github.com/tarantool/tarantool/commit/f1c76b976077e8078c42990546d9dbbdea315425.
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 by locating the public C API documentation for box_info_lsn, box_is_ro, box_ro_reason, and box_wait_ro. Compare each entry with the corresponding Lua methods box.info.lsn, box.info.ro, box.info.ro_reason, and box.wait_ro. Done means all four symbols have documented meanings consistent with their Lua counterparts.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100