Remove `cord_slab_cache` from C API reference
Open
Beginner friendly
Nobody has claimed this yet.
3.0
c api
reference
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): GitHub link(s)
Product: Tarantool
Since: 3.0
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/reference_capi/fiber/
SME: @ CuriousGeorgiy
Details
The cord_slab_cache needs to be removed from the C API reference of the
fiber module.
Requested by @CuriousGeorgiy in https://github.com/tarantool/tarantool/commit/970ea4860909b0a25555d8cbe45878cc8e94bbeb.
Definition of done
-
cord_slab_cacheisn't described in 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
Open the fiber module C API reference at the linked root document and locate the cord_slab_cache entry. Remove its description, then verify that the generated or rendered documentation no longer describes cord_slab_cache.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100