Merge pull request #33 from weiznich/improve_docs

Minor documentation improvements

Author: weiznich

src/lib.rs

@@ -26,6 +26,9 @@
 //! ```rust
 //! # include!("./doctest_setup.rs");
 //! #
+//! use diesel::prelude::*;
+//! use diesel_async::{RunQueryDsl, AsyncConnection};
+//!
 //! diesel::table! {
 //!    users(id) {
 //!        id -> Integer,
@@ -39,8 +42,9 @@
 //! # }
 //! #
 //! # async fn run_test() -> QueryResult<()> {
-//! #     use diesel::insert_into;
+//!
 //! use crate::users::dsl::*;
+//!
 //! # let mut connection = establish_connection().await;
 //! # /*
 //! let mut connection = AsyncPgConnection::establish(std::env::var("DATABASE_URL")?).await?;
@@ -49,7 +53,7 @@
 //!     // use ordinary diesel query dsl here
 //!     .filter(id.gt(0))
 //!     // execute the query via the provided
-//!     // async variant of `RunQueryDsl`
+//!     // async variant of `diesel_async::RunQueryDsl`
 //!     .load::<(i32, String)>(&mut connection)
 //!     .await?;
 //! let expected_data = vec![

src/pooled_connection/bb8.rs

@@ -6,6 +6,7 @@
 //! use futures::FutureExt;
 //! use diesel_async::pooled_connection::AsyncDieselConnectionManager;
 //! use diesel_async::pooled_connection::bb8::Pool;
+//! use diesel_async::RunQueryDsl;
 //!
 //! # #[tokio::main(flavor = "current_thread")]
 //! # async fn main() {
@@ -15,7 +16,7 @@
 //! # #[cfg(feature = "postgres")]
 //! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncPgConnection> {
 //! #     let db_url = database_url_from_env("PG_DATABASE_URL");
-//!   let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
+//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
 //! #     config
 //! #  }
 //! #
@@ -29,14 +30,14 @@
 //! # async fn run_test() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
 //! #     use schema::users::dsl::*;
 //! #     let config = get_config();
-//!   let pool = Pool::builder().build(config).await?;
-//!   let mut conn = pool.get().await?;
+//! let pool = Pool::builder().build(config).await?;
+//! let mut conn = pool.get().await?;
 //! # conn.begin_test_transaction();
 //! # clear_tables(&mut conn).await;
 //! # create_tables(&mut conn).await;
-//! #[cfg(feature = "mysql")]
+//! # #[cfg(feature = "mysql")]
 //! # conn.begin_test_transaction();
-//!   let res = users.load::<(i32, String)>(&mut conn).await?;
+//! let res = users.load::<(i32, String)>(&mut conn).await?;
 //! #     Ok(())
 //! # }
 //! ```

src/pooled_connection/deadpool.rs

@@ -6,6 +6,7 @@
 //! use futures::FutureExt;
 //! use diesel_async::pooled_connection::AsyncDieselConnectionManager;
 //! use diesel_async::pooled_connection::deadpool::Pool;
+//! use diesel_async::RunQueryDsl;
 //!
 //! # #[tokio::main(flavor = "current_thread")]
 //! # async fn main() {
@@ -15,7 +16,7 @@
 //! # #[cfg(feature = "postgres")]
 //! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncPgConnection> {
 //! #     let db_url = database_url_from_env("PG_DATABASE_URL");
-//!   let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
+//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
 //! #     config
 //! #  }
 //! #
@@ -29,13 +30,13 @@
 //! # async fn run_test() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
 //! #     use schema::users::dsl::*;
 //! #     let config = get_config();
-//!   let pool = Pool::builder(config).build()?;
-//!   let mut conn = pool.get().await?;
+//! let pool = Pool::builder(config).build()?;
+//! let mut conn = pool.get().await?;
 //! # conn.begin_test_transaction();
 //! # clear_tables(&mut conn).await;
 //! # create_tables(&mut conn).await;
 //! # conn.begin_test_transaction();
-//!   let res = users.load::<(i32, String)>(&mut conn).await?;
+//! let res = users.load::<(i32, String)>(&mut conn).await?;
 //! #     Ok(())
 //! # }
 //! ```

src/pooled_connection/mobc.rs

@@ -6,6 +6,7 @@
 //! use futures::FutureExt;
 //! use diesel_async::pooled_connection::AsyncDieselConnectionManager;
 //! use diesel_async::pooled_connection::mobc::Pool;
+//! use diesel_async::RunQueryDsl;
 //!
 //! # #[tokio::main(flavor = "current_thread")]
 //! # async fn main() {
@@ -15,7 +16,7 @@
 //! # #[cfg(feature = "postgres")]
 //! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncPgConnection> {
 //! #     let db_url = database_url_from_env("PG_DATABASE_URL");
-//!   let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
+//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
 //! #     config
 //! #  }
 //! #
@@ -29,13 +30,13 @@
 //! # async fn run_test() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
 //! #     use schema::users::dsl::*;
 //! #     let config = get_config();
-//!   let pool = Pool::new(config);
-//!   let mut conn = pool.get().await?;
+//! let pool = Pool::new(config);
+//! let mut conn = pool.get().await?;
 //! # conn.begin_test_transaction();
 //! # clear_tables(&mut conn).await;
 //! # create_tables(&mut conn).await;
 //! # conn.begin_test_transaction();
-//!   let res = users.load::<(i32, String)>(&mut conn).await?;
+//! let res = users.load::<(i32, String)>(&mut conn).await?;
 //! #     Ok(())
 //! # }
 //! ```