Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some missing backticks in doc comments. #101

Merged
merged 1 commit into from
Jul 7, 2024
Merged

Add some missing backticks in doc comments. #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,19 +451,19 @@ impl<B: BitBlock> BitVec<B> {
}
}

/// Exposes the raw block storage of this BitVec
/// Exposes the raw block storage of this `BitVec`.
///
/// Only really intended for BitSet.
/// Only really intended for `BitSet`.
#[inline]
pub fn storage(&self) -> &[B] {
&self.storage
}

/// Exposes the raw block storage of this BitVec
/// Exposes the raw block storage of this `BitVec`.
///
/// # Safety
///
/// Can probably cause unsafety. Only really intended for BitSet.
/// Can probably cause unsafety. Only really intended for `BitSet`.
#[inline]
pub unsafe fn storage_mut(&mut self) -> &mut Vec<B> {
&mut self.storage
Expand Down Expand Up @@ -1525,7 +1525,7 @@ impl<B: BitBlock> BitVec<B> {
self.fix_last_block();
}

/// Removes the last bit from the BitVec, and returns it. Returns None if the BitVec is empty.
/// Removes the last bit from the `BitVec`, and returns it. Returns `None` if the `BitVec` is empty.
///
/// # Examples
///
Expand Down Expand Up @@ -1585,11 +1585,11 @@ impl<B: BitBlock> BitVec<B> {
self.nbits
}

/// Sets the number of bits that this BitVec considers initialized.
/// Sets the number of bits that this `BitVec` considers initialized.
///
/// # Safety
///
/// Almost certainly can cause bad stuff. Only really intended for BitSet.
/// Almost certainly can cause bad stuff. Only really intended for `BitSet`.
#[inline]
pub unsafe fn set_len(&mut self, len: usize) {
self.nbits = len;
Expand Down
Loading