Improve documentation.

ideal-world · Apr 3, 2023 · 4e03e1b · 4e03e1b
1 parent 12956d4
commit 4e03e1b
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 14 deletions.
diff --git a/tardis/Cargo.toml b/tardis/Cargo.toml
@@ -133,15 +133,15 @@ lapin = { version = "2.0", optional = true }
 amq-protocol-types = { version = "7.0", optional = true }
 async-global-executor = { version = "2.0", optional = true }
 
-#Mail
+# Mail
 lettre = { version = "0.10.0-rc.6", features = [
     "smtp-transport",
     "tokio1",
     "tokio1-native-tls",
     "builder",
 ], optional = true }
 
-#Object Storage
+# Object Storage
 rust-s3 = { version = "0.32", optional = true }
 anyhow = { version = "1.0", optional = true }
 

diff --git a/tardis/src/lib.rs b/tardis/src/lib.rs
@@ -95,19 +95,21 @@
 //! }
 //! ```
 //!
-//! ### use sqlparser::ast::Action::Usage;More examples
+//! ### More examples
 //!
-//!> |-- examples  
-//!>   |-- reldb              Relational database usage example
-//!>   |-- web-basic          Web service Usage Example
-//!>   |-- web-client         Web client Usage Example
-//!>   |-- websocket          WebSocket Usage Example
-//!>   |-- cache              Cache Usage Example
-//!>   |-- mq                 Message Queue Usage Example
-//!>   |-- todos              A complete project usage example
-//!>   |-- multi-apps         Multi-application aggregation example
-//!>   |-- pg-graph-search    Graph search by Postgresql example
-//!>   |-- perf-test          Performance test case
+//! ```
+//! |-- examples  
+//!   |-- reldb              Relational database usage example
+//!   |-- web-basic          Web service Usage Example
+//!   |-- web-client         Web client Usage Example
+//!   |-- websocket          WebSocket Usage Example
+//!   |-- cache              Cache Usage Example
+//!   |-- mq                 Message Queue Usage Example
+//!   |-- todos              A complete project usage example
+//!   |-- multi-apps         Multi-application aggregation example
+//!   |-- pg-graph-search    Graph search by Postgresql example
+//!   |-- perf-test          Performance test case
+//! ```
 
 #![doc(html_logo_url = "https://raw.githubusercontent.com/ideal-world/tardis/main/logo.png")]
 #![cfg_attr(docsrs, feature(doc_cfg))]