Skip to content

Commit

Permalink
Merge pull request #35 from nickbabcock/docs
Browse files Browse the repository at this point in the history
Remove redundant doc links
  • Loading branch information
nickbabcock authored Jan 31, 2024
2 parents cb6d5af + c97ccc1 commit 022e881
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ pub trait BitReader {
/// Refills the lookahead buffer and returns the number of bits available to
/// consume.
///
/// The return value will be less than [`MAX_READ_BITS`](crate::MAX_READ_BITS)
/// The return value will be less than [`MAX_READ_BITS`]
///
/// A core tenent of Manual Mode: refill / peek / consume
fn refill_lookahead(&mut self) -> u32;
Expand All @@ -396,8 +396,7 @@ pub trait BitReader {
/// Guard any usage with
/// [`has_bits_remaining`](BitReader::has_bits_remaining)
///
/// There is no return value as it would always be
/// [`MAX_READ_BITS`](crate::MAX_READ_BITS)
/// There is no return value as it would always be [`MAX_READ_BITS`]
///
/// # Safety
///
Expand All @@ -423,7 +422,7 @@ const BIT_WIDTH: usize = BYTE_WIDTH * 8;

/// The maximum number of bits available to buffer
///
/// [BitReader::refill_lookahead](BitReader::refill_lookahead) returns a maximum equal to this constant.
/// [BitReader::refill_lookahead] returns a maximum equal to this constant.
///
/// Use static assertions to ensure that your data model fits within expected number of refills
///
Expand Down Expand Up @@ -824,8 +823,7 @@ pub type NativeEndianReader<'a> = BigEndianReader<'a>;

/// Arbitrary sign extension for manual mode API.
///
/// See [`BitReader::read_signed_bits`](BitReader::read_signed_bits) for more
/// information
/// See [`BitReader::read_signed_bits`] for more information
///
/// It is assumed the input value has zeros for bits above the given position.
///
Expand Down

0 comments on commit 022e881

Please sign in to comment.