Skip to content

Commit 1b288b9

Browse files
authored
Merge pull request #33 from weiznich/improve_docs
Minor documentation improvements
2 parents 96688d4 + 52a26d6 commit 1b288b9

File tree

4 files changed

+22
-15
lines changed

4 files changed

+22
-15
lines changed

src/lib.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@
2626
//! ```rust
2727
//! # include!("./doctest_setup.rs");
2828
//! #
29+
//! use diesel::prelude::*;
30+
//! use diesel_async::{RunQueryDsl, AsyncConnection};
31+
//!
2932
//! diesel::table! {
3033
//! users(id) {
3134
//! id -> Integer,
@@ -39,8 +42,9 @@
3942
//! # }
4043
//! #
4144
//! # async fn run_test() -> QueryResult<()> {
42-
//! # use diesel::insert_into;
45+
//!
4346
//! use crate::users::dsl::*;
47+
//!
4448
//! # let mut connection = establish_connection().await;
4549
//! # /*
4650
//! let mut connection = AsyncPgConnection::establish(std::env::var("DATABASE_URL")?).await?;
@@ -49,7 +53,7 @@
4953
//! // use ordinary diesel query dsl here
5054
//! .filter(id.gt(0))
5155
//! // execute the query via the provided
52-
//! // async variant of `RunQueryDsl`
56+
//! // async variant of `diesel_async::RunQueryDsl`
5357
//! .load::<(i32, String)>(&mut connection)
5458
//! .await?;
5559
//! let expected_data = vec![

src/pooled_connection/bb8.rs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
//! use futures::FutureExt;
77
//! use diesel_async::pooled_connection::AsyncDieselConnectionManager;
88
//! use diesel_async::pooled_connection::bb8::Pool;
9+
//! use diesel_async::RunQueryDsl;
910
//!
1011
//! # #[tokio::main(flavor = "current_thread")]
1112
//! # async fn main() {
@@ -15,7 +16,7 @@
1516
//! # #[cfg(feature = "postgres")]
1617
//! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncPgConnection> {
1718
//! # let db_url = database_url_from_env("PG_DATABASE_URL");
18-
//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
19+
//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
1920
//! # config
2021
//! # }
2122
//! #
@@ -29,14 +30,14 @@
2930
//! # async fn run_test() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
3031
//! # use schema::users::dsl::*;
3132
//! # let config = get_config();
32-
//! let pool = Pool::builder().build(config).await?;
33-
//! let mut conn = pool.get().await?;
33+
//! let pool = Pool::builder().build(config).await?;
34+
//! let mut conn = pool.get().await?;
3435
//! # conn.begin_test_transaction();
3536
//! # clear_tables(&mut conn).await;
3637
//! # create_tables(&mut conn).await;
37-
//! #[cfg(feature = "mysql")]
38+
//! # #[cfg(feature = "mysql")]
3839
//! # conn.begin_test_transaction();
39-
//! let res = users.load::<(i32, String)>(&mut conn).await?;
40+
//! let res = users.load::<(i32, String)>(&mut conn).await?;
4041
//! # Ok(())
4142
//! # }
4243
//! ```

src/pooled_connection/deadpool.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
//! use futures::FutureExt;
77
//! use diesel_async::pooled_connection::AsyncDieselConnectionManager;
88
//! use diesel_async::pooled_connection::deadpool::Pool;
9+
//! use diesel_async::RunQueryDsl;
910
//!
1011
//! # #[tokio::main(flavor = "current_thread")]
1112
//! # async fn main() {
@@ -15,7 +16,7 @@
1516
//! # #[cfg(feature = "postgres")]
1617
//! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncPgConnection> {
1718
//! # let db_url = database_url_from_env("PG_DATABASE_URL");
18-
//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
19+
//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
1920
//! # config
2021
//! # }
2122
//! #
@@ -29,13 +30,13 @@
2930
//! # async fn run_test() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
3031
//! # use schema::users::dsl::*;
3132
//! # let config = get_config();
32-
//! let pool = Pool::builder(config).build()?;
33-
//! let mut conn = pool.get().await?;
33+
//! let pool = Pool::builder(config).build()?;
34+
//! let mut conn = pool.get().await?;
3435
//! # conn.begin_test_transaction();
3536
//! # clear_tables(&mut conn).await;
3637
//! # create_tables(&mut conn).await;
3738
//! # conn.begin_test_transaction();
38-
//! let res = users.load::<(i32, String)>(&mut conn).await?;
39+
//! let res = users.load::<(i32, String)>(&mut conn).await?;
3940
//! # Ok(())
4041
//! # }
4142
//! ```

src/pooled_connection/mobc.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
//! use futures::FutureExt;
77
//! use diesel_async::pooled_connection::AsyncDieselConnectionManager;
88
//! use diesel_async::pooled_connection::mobc::Pool;
9+
//! use diesel_async::RunQueryDsl;
910
//!
1011
//! # #[tokio::main(flavor = "current_thread")]
1112
//! # async fn main() {
@@ -15,7 +16,7 @@
1516
//! # #[cfg(feature = "postgres")]
1617
//! # fn get_config() -> AsyncDieselConnectionManager<diesel_async::AsyncPgConnection> {
1718
//! # let db_url = database_url_from_env("PG_DATABASE_URL");
18-
//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
19+
//! let config = AsyncDieselConnectionManager::<diesel_async::AsyncPgConnection>::new(db_url);
1920
//! # config
2021
//! # }
2122
//! #
@@ -29,13 +30,13 @@
2930
//! # async fn run_test() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
3031
//! # use schema::users::dsl::*;
3132
//! # let config = get_config();
32-
//! let pool = Pool::new(config);
33-
//! let mut conn = pool.get().await?;
33+
//! let pool = Pool::new(config);
34+
//! let mut conn = pool.get().await?;
3435
//! # conn.begin_test_transaction();
3536
//! # clear_tables(&mut conn).await;
3637
//! # create_tables(&mut conn).await;
3738
//! # conn.begin_test_transaction();
38-
//! let res = users.load::<(i32, String)>(&mut conn).await?;
39+
//! let res = users.load::<(i32, String)>(&mut conn).await?;
3940
//! # Ok(())
4041
//! # }
4142
//! ```

0 commit comments

Comments
 (0)