Skip to content

Commit

Permalink
Enable doctests
Browse files Browse the repository at this point in the history
Doctests were disabled globally because up until #2456, they were just
formatting examples which were not supposed to compile. Now that there
is one runnable doctest, I disabled the other ones individually (by
adding the ignore directive).

I also added some empty lines around the code blocks to avoid the
following warning and instead ignore the code blocks cleanly:

WARNING: ... Code block is not currently run as a test, but will in
future versions of rustdoc. Please ensure this code block is a runnable
test, or use the `ignore` directive.

See #28712 for further details.
  • Loading branch information
dlukes committed Mar 10, 2018
1 parent e68bd9e commit a41947c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
3 changes: 0 additions & 3 deletions Cargo.toml
Expand Up @@ -10,9 +10,6 @@ license = "Apache-2.0/MIT"
build = "build.rs"
categories = ["development-tools"]

[lib]
doctest = false

[[bin]]
name = "rustfmt"
path = "src/bin/main.rs"
Expand Down
14 changes: 10 additions & 4 deletions src/chains.rs
Expand Up @@ -25,16 +25,19 @@
//! E.g., `let foo = { aaaa; bbb; ccc }.bar.baz();`, we would layout for the
//! following values of `chain_indent`:
//! Block:
//! ```
//!
//! ```ignore
//! let foo = {
//! aaaa;
//! bbb;
//! ccc
//! }.bar
//! .baz();
//! ```
//!
//! Visual:
//! ```
//!
//! ```ignore
//! let foo = {
//! aaaa;
//! bbb;
Expand All @@ -47,13 +50,16 @@
//! If the first item in the chain is a block expression, we align the dots with
//! the braces.
//! Block:
//! ```
//!
//! ```ignore
//! let a = foo.bar
//! .baz()
//! .qux
//! ```
//!
//! Visual:
//! ```
//!
//! ```ignore
//! let a = foo.bar
//! .baz()
//! .qux
Expand Down
9 changes: 6 additions & 3 deletions src/macros.rs
Expand Up @@ -621,7 +621,8 @@ fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {

/// Indent each line according to the specified `indent`.
/// e.g.
/// ```rust
///
/// ```rust,ignore
/// foo!{
/// x,
/// y,
Expand All @@ -632,8 +633,10 @@ fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
/// ),
/// }
/// ```
///
/// will become
/// ```rust
///
/// ```rust,ignore
/// foo!{
/// x,
/// y,
Expand Down Expand Up @@ -864,7 +867,7 @@ impl MacroBranch {
///
/// # Expected syntax
///
/// ```
/// ```ignore
/// lazy_static! {
/// [pub] static ref NAME_1: TYPE_1 = EXPR_1;
/// [pub] static ref NAME_2: TYPE_2 = EXPR_2;
Expand Down

0 comments on commit a41947c

Please sign in to comment.