quickwit-oss / quickwit-oss/quickwit
Better interface description for Storage abstraction
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
My documentation idea
The current docstring for the get_slice method in the Storage trait does not specify what is expected to happen if the bounds defined by the range attribute are greater than the file size.
Rational:
Some users of the abstraction that want to avoid making the extra call to get the file size might want to call get_slice with a predefined chunk size, and it's unclear whether that's allowed for this abstraction or not.
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 quickwit-storage/src/storage.rs and read the get_slice method documentation at the referenced lines. Clarify what happens when the requested range exceeds the file size, including whether callers may use a predefined chunk size without first checking the file size. Done means the Storage trait documentation states this behavior unambiguously.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- backend
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100