A new `offset` parameter of the `index:pairs` method
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Since: 3.3.0
Root document:
- https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_index/pairs/
- (possibly) https://www.tarantool.io/en/doc/latest/platform/ddl_dml/using_indexes/
SME: @ mkostoevr
Details
Now the index:pairs method supports the offset parameter which may
be used to skip the specified amount of tuples of the iterator. If the
skip caused the iterator to exhaust, it behaves as expected (no tuple
is returned).
Requested by @mkostoevr in https://github.com/tarantool/tarantool/commit/dbf4e63b9ece388cc99b3864c02e70ee34b9fb8f.
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 referenced index:pairs documentation page and review its parameter and iterator behavior sections. Update the documentation to describe the offset parameter, including that skipping beyond the available tuples returns no tuple; also check whether the using-indexes page needs the same information. There are no tests mentioned in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100