RoaringBitmap / RoaringBitmap/roaring-rs

Revert order of modules and disable rustfmt for them

Open
#65 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
957
Forks
119
Avg merge
3d 3h
Merged PRs (30d)
1

Description

https://github.com/Nemo157/roaring-rs/blob/bc97c1400d11b75ff92f61040e21772de8c8f8c3/src/bitmap/mod.rs#L6-L12

These shouldn't have been reordered with rustfmt since they affect the documentation rendering.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at src/bitmap/mod.rs lines 6-12 and inspect the referenced commit to identify the module reordering. Restore the intended order and prevent rustfmt from reordering these modules, then verify that the generated documentation rendering is preserved.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, tooling
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.