style(lib): add extra examples to connection_type in GenerationConf…

…ig and binary help
Wulf · Nov 19, 2023 · 830655e · 830655e
1 parent 58462ca
commit 830655e
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/src/bin/main.rs b/src/bin/main.rs
@@ -63,8 +63,15 @@ pub struct MainOptions {
     #[arg(short = 'g', long = "autogenerated-columns")]
     pub autogenerated_columns: Option<Vec<String>>,
 
-    /// rust type which describes a connection, for example: "diesel::r2d2::PooledConnection<diesel::r2d2::ConnectionManager<diesel::pg::PgConnection>>"
-    #[arg(short = 'c', long = "connection-type")]
+    /// rust type which describes a connection
+    ///
+    /// For example:
+    /// - `diesel::pg::PgConnection`
+    /// - `diesel::sqlite::SqliteConnection`
+    /// - `diesel::mysql::MysqlConnection`
+    /// - `diesel::r2d2::PooledConnection<diesel::r2d2::ConnectionManager<diesel::pg::PgConnection>>`
+    /// - or, your custom diesel connection type (struct which implements `diesel::connection::Connection`)
+    #[arg(short = 'c', long = "connection-type", verbatim_doc_comment)]
     pub connection_type: String,
 
     /// Disable generating serde implementations

diff --git a/src/lib.rs b/src/lib.rs
@@ -248,7 +248,12 @@ pub struct GenerationConfig<'a> {
     pub default_table_options: TableOptions<'a>,
     /// Connection type to insert
     ///
-    /// Example: `diesel::SqliteConnection`
+    /// For example:
+    /// - `diesel::pg::PgConnection`
+    /// - `diesel::sqlite::SqliteConnection`
+    /// - `diesel::mysql::MysqlConnection`
+    /// - `diesel::r2d2::PooledConnection<diesel::r2d2::ConnectionManager<diesel::pg::PgConnection>>`
+    /// - or, your custom diesel connection type (struct which implements `diesel::connection::Connection`)
     pub connection_type: String,
     /// Diesel schema import path
     ///