Skip to content

Commit

Permalink
Minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
boydgreenfield committed Oct 5, 2023
1 parent 64917f5 commit 791cca2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
#![deny(missing_docs)]
//! mmap-bitvec is a library for using file-backed (via mmap) bit vectors and
//! `mmap-bitvec` is a library for using file-backed (via mmap) bit vectors and
//! includes common convenience functions and a few data structures built atop
//! the included bit vector implementation.
#[doc = include_str!("../README.md")]
/// The bitvec trait and some impl for built-in types
/// The `bitvec` trait and some impl for built-in types
pub mod bitvec;
/// A simple implementation of a Bloom filter backed by `BitVec`
pub mod bloom;
/// All the utilities to interact with a mmapped bitvector
/// All the utilities to interact with a mmap'd bitvector
pub mod mmap_bitvec;

#[doc(inline)]
Expand Down
2 changes: 1 addition & 1 deletion src/mmap_bitvec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ pub struct MmapBitVec {
pub size: usize,
/// Arbitrary data prepended to file (when file-backed)
header: Box<[u8]>,
/// controls whether the mapping is backed by a file (see `MAP_ANONYMOUS` here: https://man7.org/linux/man-pages/man2/mmap.2.html)
/// controls whether the mapping is backed by a file (see `MAP_ANONYMOUS` here: <https://man7.org/linux/man-pages/man2/mmap.2.html>)
is_map_anonymous: bool,
}

Expand Down

0 comments on commit 791cca2

Please sign in to comment.