feedback: Module index
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
<…>dex_id (uint32_t) – index identifier
type (int) – iterator_type
|key (const char) – encode key in MsgPack Array format ([part1, part2, …])|*
key_end (const char*) – the end of encoded keyReturns:NU<…>
https://www.tarantool.io/en/doc/latest/reference/reference_capi/box_index/
you must specify that the caller is required to keep the key buffer alive during the iterator lifetime (it is used by original pointer within box_iterator_next())
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
Open the linked box_index C API reference and locate the iterator key parameter description. Update it to state that callers must keep the key buffer alive for the iterator lifetime because box_iterator_next() uses the original pointer, then verify the rendered documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100