Skip to content

Commit 791cca2

Browse files
Minor doc updates
1 parent 64917f5 commit 791cca2

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/lib.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#![deny(missing_docs)]
2-
//! mmap-bitvec is a library for using file-backed (via mmap) bit vectors and
2+
//! `mmap-bitvec` is a library for using file-backed (via mmap) bit vectors and
33
//! includes common convenience functions and a few data structures built atop
44
//! the included bit vector implementation.
55
#[doc = include_str!("../README.md")]
6-
/// The bitvec trait and some impl for built-in types
6+
/// The `bitvec` trait and some impl for built-in types
77
pub mod bitvec;
88
/// A simple implementation of a Bloom filter backed by `BitVec`
99
pub mod bloom;
10-
/// All the utilities to interact with a mmapped bitvector
10+
/// All the utilities to interact with a mmap'd bitvector
1111
pub mod mmap_bitvec;
1212

1313
#[doc(inline)]

src/mmap_bitvec.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ pub struct MmapBitVec {
7676
pub size: usize,
7777
/// Arbitrary data prepended to file (when file-backed)
7878
header: Box<[u8]>,
79-
/// controls whether the mapping is backed by a file (see `MAP_ANONYMOUS` here: https://man7.org/linux/man-pages/man2/mmap.2.html)
79+
/// controls whether the mapping is backed by a file (see `MAP_ANONYMOUS` here: <https://man7.org/linux/man-pages/man2/mmap.2.html>)
8080
is_map_anonymous: bool,
8181
}
8282

0 commit comments

Comments
 (0)