Document `box_slab_info` C API function
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Since: Tarantool 3.3.0
Added the new C function box_slab_info that returns information about
the memory state depending on the passed argument box_slab_info_type.
The same information is available in Lua via box.slab.info().
Requested by @SEChudinov in https://github.com/tarantool/tarantool/commit/bd510bb5cc229cdcaa6df1fdebc185a1171bc698.
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 existing documentation for the Lua entry point box.slab.info() and the C API reference for box_slab_info. Document that box_slab_info was added in Tarantool 3.3.0, explain its box_slab_info_type argument and returned memory-state information, and ensure the C API description matches the Lua documentation.
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
- 55/100