RoaringBitmap / RoaringBitmap/roaring-rs
Operators are not discoverable
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 957
- Forks
- 119
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 1
Description
Because of the bitwise operators being traits they're not very discoverable in the documentation. Would probably pay to add a section to the main struct docs/crate docs for them.
Contributor guide
No contributing guide indexed for this repository
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 by locating the main struct documentation and crate-level documentation, then inspect how the bitwise-operator traits are currently documented. Done means the relevant operators are discoverable from a main documentation entry point, with the exact scope confirmed from the existing Rust docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100