Skip to content

Commit 340212d

Browse files
committed
Merge pull request #209 from robertmaloney/rm/doc-fix
Fix documentation for `debug_sql!` and `print_sql!`
2 parents 2d05632 + 1b38186 commit 340212d

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

diesel/src/macros.rs

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -385,17 +385,24 @@ macro_rules! join_through {
385385
/// # Example
386386
///
387387
/// ### Returning SQL from a count statment:
388-
/// #
389-
/// # ```rust
388+
///
389+
/// ```rust
390+
/// # #[macro_use] extern crate diesel;
391+
/// # table! {
392+
/// # users {
393+
/// # id -> Timestamp,
394+
/// # n -> Integer,
395+
/// # }
396+
/// # }
390397
/// # // example requires setup for users table
391-
/// # use diesel::users::dsl::*;
392-
/// # use diesel::query_builder::QueryFragment;
398+
/// # use self::users::dsl::*;
399+
/// # use diesel::*;
393400
/// #
394401
/// # fn main() {
395402
/// let sql = debug_sql!(users.count());
396-
/// assert_eq!(sql, "SELECT COUNT(*) FROM users");
403+
/// assert_eq!(sql, "SELECT COUNT(*) FROM `users`");
397404
/// # }
398-
/// # ```
405+
/// ```
399406
#[macro_export]
400407
macro_rules! debug_sql {
401408
($query:expr) => {{
@@ -413,16 +420,23 @@ macro_rules! debug_sql {
413420
/// # Example
414421
///
415422
/// ### Printing SQL from a count statment:
416-
/// #
417-
/// # ```rust
423+
///
424+
/// ```rust
425+
/// # #[macro_use] extern crate diesel;
426+
/// # table! {
427+
/// # users {
428+
/// # id -> Timestamp,
429+
/// # n -> Integer,
430+
/// # }
431+
/// # }
418432
/// # // example requires setup for users table
419-
/// # use diesel::users::dsl::*;
420-
/// # use diesel::query_builder::QueryFragment;
433+
/// # use self::users::dsl::*;
434+
/// # use diesel::*;
421435
/// #
422436
/// # fn main() {
423437
/// print_sql!(users.count());
424438
/// # }
425-
/// # ```
439+
/// ```
426440
#[macro_export]
427441
macro_rules! print_sql {
428442
($query:expr) => {

0 commit comments

Comments
 (0)