Skip to content

Commit

Permalink
Fix some doc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
Kerollmops committed Jan 23, 2021
1 parent 9828986 commit 72c23d1
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion heed-types/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//! For specific types you can choose:
//! - [`Str`] to store [`str`](primitive@str)s
//! - [`Unit`] to store `()` types
//! - [`SerdeBincode`] or [`SerdeJson`] to store [`Serialize`]/[`Deserialize`] types
//! - [`SerdeBincode`] or [`SerdeJson`] to store [`serde::Serialize`]/[`serde::Deserialize`] types
//!
//! But if you want to store big types that can be efficiently deserialized then
//! here is a little table to help you in your quest:
Expand Down
2 changes: 1 addition & 1 deletion heed-types/src/str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use std::{str, marker};
use heed_traits::{BytesDecode, BytesEncode};
use bytemuck::try_cast_slice;

/// Describes an [`str`].
/// Describes an [`prim@str`].
pub struct Str<'a> {
_phantom: marker::PhantomData<&'a ()>,
}
Expand Down
1 change: 1 addition & 0 deletions heed/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ impl EnvOpenOptions {
}

/// Set one or [more LMDB flags](http://www.lmdb.tech/doc/group__mdb__env.html).
///
/// ```
/// use std::fs;
/// use std::path::Path;
Expand Down

0 comments on commit 72c23d1

Please sign in to comment.