Github | Crates.io | Docs.rs

Quote doesn't seem to support string interpolation in doc attributes, so I made this little helper to generate doctests.

UPDATE: 0.2 is now out with many improvements. It now uses 'prettyplease' by default for formatting and can handle blank lines and comments in the doc test.

Here is an example of usage:

``rust // Takes anyTokenStreamas input (but typicallyquote` would be used) let test = doc_test!(quote! { _comment!("Calling fibonacci with 10 returns 55"); assert_eq!(fibonacci(10), 55);

    _blank!();
    _comment!("Calling fibonacci with 1 simply returns 1");
    assert_eq!(fibonacci(1), 1);
}).unwrap();

let comment = doc_comment("This compares between fib inputs and outputs:\n\n").unwrap();

// Interpolates into a regular `quote` invocation
let actual = quote! {
    #comment
    #test
    fn fibonacci(n: u64) -> u64 {
        match n {
            0 => 1,
            1 => 1,
            n => fibonacci(n - 1)   fibonacci(n - 2),
        }
    }
};

```

It generates this:

rust let expected = quote! { /// This compares between fib inputs and outputs: /// /// /// // Calling fibonacci with 10 returns 55 /// assert_eq!(fibonacci(10), 55); /// /// // Calling fibonacci with 1 simply returns 1 /// assert_eq!(fibonacci(1), 1); /// fn fibonacci(n: u64) -> u64 { match n { 0 => 1, 1 => 1, n => fibonacci(n - 1) fibonacci(n - 2), } } };