Skip to content

Commit

Permalink
Fixed typo in OffsetsBuffer docs (jorgecarleitao#1373)
Browse files Browse the repository at this point in the history
`OffsetsBuffer` has the same invariants as `Offsets`, which requires
each element to be greater *or equal* to `0`.
  • Loading branch information
DzenanJupic authored and ritchie46 committed Apr 5, 2023
1 parent af9a0a0 commit 2e4f8da
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/offset.rs
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ fn try_check_offsets<O: Offset>(offsets: &[O]) -> Result<(), Error> {

/// A wrapper type of [`Buffer<O>`] that is guaranteed to:
/// * Always contain an element
/// * Every element is `>0`
/// * Every element is `>= 0`
/// * element at position `i` is >= than element at position `i-1`.
#[derive(Clone, PartialEq, Debug)]
pub struct OffsetsBuffer<O: Offset>(Buffer<O>);
Expand Down

0 comments on commit 2e4f8da

Please sign in to comment.