Doc: Add doc to pub sub-mod

openraft/src/async_runtime.rs

@@ -1,3 +1,7 @@
+//! `async` runtime interface.
+//!
+//! `async` runtime is an abstraction over different asynchronous runtimes, such as `tokio`,
+//! `async-std`, etc.
 use std::fmt::Debug;
 use std::fmt::Display;
 use std::future::Future;

openraft/src/entry/mod.rs

@@ -1,3 +1,5 @@
+//! The default log entry type that implements [`RaftEntry`].
+
 use std::fmt;
 use std::fmt::Debug;
 

openraft/src/instant.rs

@@ -1,3 +1,5 @@
+//! A trait for time instants.
+
 use std::fmt::Debug;
 use std::ops::Add;
 use std::ops::AddAssign;

openraft/src/lib.rs

@@ -48,11 +48,11 @@ pub mod network;
 pub mod raft;
 pub mod storage;
 pub mod testing;
-pub mod timer;
-pub mod type_config;
 
 pub(crate) mod engine;
 pub(crate) mod log_id_range;
+pub(crate) mod timer;
+pub(crate) mod type_config;
 pub(crate) mod utime;
 
 mod display_ext;

openraft/src/testing/mod.rs

@@ -1,3 +1,5 @@
+//! Testing utilities for OpenRaft.
+
 mod store_builder;
 mod suite;