[2pt] Describe limitations and difference in behaviors of box operations for memtx and vinyl
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
What needs to be done
Reviewer: @ documentarian name
Right now we have a separate page about engines (memtx and vinyl) where differences and limitations are described. However, pages that describe box operations don't mention these limitations and differences. For example box:len() - https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/len/
I propose to fix it.
Definition of done
- pages about
box:alter(),box:random(),box:len(),box:count()andbox:delete()describes a difference in behaviour for memx and vinyl engines OR contains a link to a page where these differences described.
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 existing engines page covering memtx and vinyl, then review the documentation pages for box:alter(), box:random(), box:len(), box:count(), and box:delete(). Compare their current descriptions with the engine differences and limitations, and consider the box:len() page as the example entry point. Done means each page describes the engine-specific behavior or links to a page that does.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100