Update C API reference > Module lua/utils
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): https://github.com/tarantool/tarantool-ee/issues/712
Product: Tarantool
Since: different versions (including 3.2)
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/reference_capi/utils/
SME: @ Gumix
Details
The following functions are missed in the documentation:
- luaL_iscallable
- luaL_iscdata
- luaL_isnull (3.2)
- luaL_pushnull (3.2)
- luaT_call
- luaT_checktuple
- luaT_isdecimal
- luaT_newdecimal
- luaT_pushdecimal
- luaT_toibuf
- luaT_tolstring
- luaT_tuple_encode
- luaT_tuple_new
See also: https://github.com/tarantool/doc/issues/2011
Requested by @ Gumix in https://github.com/tarantool/tarantool/commit/a6140a3e7a1cb79d152422413df1b43bc37cffdc.
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 Tarantool C API reference at dev_guide/reference_capi/utils/ and compare its documented functions with the list in this issue. Add reference entries for all 13 missing functions, including the 3.2-specific functions, and verify that the utils module page covers each requested API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100