[docs] Replace all 'allow(missing_docs)' with basic docs

This commit is contained in:
Steve Myers
2020-12-16 13:57:01 -08:00
parent 8cfbf1f0a2
commit fb5c70fc64
4 changed files with 29 additions and 29 deletions

View File

@@ -89,11 +89,11 @@ macro_rules! impl_inner_method {
/// See [this module](crate::database::any)'s documentation for a usage example.
#[derive(Debug)]
pub enum AnyDatabase {
#[allow(missing_docs)]
/// In-memory ephemeral database
Memory(memory::MemoryDatabase),
#[cfg(feature = "key-value-db")]
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
#[allow(missing_docs)]
/// Simple key-value embedded database based on [`sled`]
Sled(sled::Tree),
}
@@ -102,11 +102,11 @@ impl_from!(sled::Tree, AnyDatabase, Sled, #[cfg(feature = "key-value-db")]);
/// Type that contains any of the [`BatchDatabase::Batch`] types defined by the library
pub enum AnyBatch {
#[allow(missing_docs)]
/// In-memory ephemeral database
Memory(<memory::MemoryDatabase as BatchDatabase>::Batch),
#[cfg(feature = "key-value-db")]
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
#[allow(missing_docs)]
/// Simple key-value embedded database based on [`sled`]
Sled(<sled::Tree as BatchDatabase>::Batch),
}
@@ -364,7 +364,7 @@ pub enum AnyDatabaseConfig {
Memory(()),
#[cfg(feature = "key-value-db")]
#[cfg_attr(docsrs, doc(cfg(feature = "key-value-db")))]
#[allow(missing_docs)]
/// Simple key-value embedded database based on [`sled`]
Sled(SledDbConfiguration),
}