Skip to content

Doc comment for run_optimize does not match CRoaring's doc comment for the same #176

Closed
@Dr-Emann

Description

@Dr-Emann

The documentation for roaring_bitmap_run_optimize found here says:

Returns true if the result has at least one run container.

But the docs in the croaring crate state:

Compresses of the bitmap. Returns true if the bitmap was modified.

We're a thin wrapper around CRoaring, our run_optimize function is just a thin wrapper around CRoaring's roaring_bitmap_run_optimize.

pub fn run_optimize(&mut self) -> bool {
unsafe { ffi::roaring_bitmap_run_optimize(&mut self.bitmap) }
}

Need to determine which doc comment is correct, (assuming it's CRoaring's) and fix the comment.

Originally posted by @lucascool12 in RoaringBitmap/roaring-rs#320 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions