module api: new region, ibuf, key_def, tuple, Lua/C APIs
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
We have added the bunch of new APIs in order to implement the new tuple-keydef and tuple-merger external modules. It would be good to document the new C structures and functions.
The relevant descriptions may be found in API comments in the header files, see the patchset. It was land to master (future 2.6.1), 2.5 (future 2.5.2), 2.4 (future 2.4.3) and 1.10 (future 1.10.8). Aside of the linked changes luaL_iscallable() was backported to 1.10.
The work was done in the scope of the following issues:
https://github.com/tarantool/tarantool/issues/5273
https://github.com/tarantool/tarantool/issues/5384
BTW, is not it worth to generate the C API documentation from the Doxygen comments in the generated src/module.h? However first we should investigate the difference in the current state of the Doxygen comments and the RST docs.
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 comparing the Doxygen comments in the generated src/module.h and the existing RST documentation, using the linked patchset and API comments in the header files as references. Document the new region, ibuf, key_def, tuple, and Lua/C API structures and functions; done means the relevant APIs are covered consistently across the affected documentation versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, lua
- Domain
- backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100