[3pt] C API: Add description of luaT_checktuple function
Open
Nobody has claimed this yet.
feature
reference
server
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
C API: luaT_checktuple function
Product: Tarantool
Since: 2.4.1
Audience/target: C devs
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/reference_capi/utils/
SME: @alyapunov
Peer reviewer:
Details
- Describe
luaT_checktuplefunction added in thelua/utilsmodule - Related development issues and/or commits: https://github.com/tarantool/tarantool/issues/2553
Definition of done
-
luaT_checktuplefunction is described in thelua/utilsmodule chapter - add cross-references with the RN item in https://www.tarantool.io/en/doc/latest/release/2.4.1/#lua
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 C API utilities root document at https://www.tarantool.io/en/doc/latest/dev_guide/reference_capi/utils/ and inspect the lua/utils module chapter. Add the luaT_checktuple function description and cross-reference it with the 2.4.1 release-note item, then verify both links and the documented function details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100