Make an example more clear with sample code.

[steveklabnik]

Fixes #11113.

[steveklabnik]

May want to elaborate a bit more, I'm not 100% sure.

[pnkfelix]

After reading #11113, I will just comment that instead of the original sentence ("This excludes let from matching literals and most enum variants."), I would personally prefer a phrasing like "This excludes let from using literals and most enum variants as its binding patterns, since most such patterns are not irrefutable."

But I don't mind using an example in addition. :)

[pnkfelix]

(Or even just "This excludes let from matching literals (and most enum variants) on the left-hand-side of the let." could work.)

[alexcrichton]

I think you'll need an ignore directive to not run this as a test because it would otherwise fail.

[steveklabnik]

@alexcrichton I thought so too, but I thought I compiled and it worked. Which seemed bad.

[alexcrichton]

Just as an example:

$ rustdoc --test src/doc/tutorial.md

running 161 tests
... /* snip */

failures:

---- Control_structures_7 stdout ----
    <anon>:5:9: 5:15 error: refutable pattern in local binding: `(_, _)` not covered
    <anon>:5     let (a, 2) = (1, 2);
                     ^~~~~~
    error: aborting due to previous error
    task 'Control_structures_7' failed at 'Box<Any>', /Users/rustbuild/src/rust-buildbot/slave/nightly-mac/build/src/libsyntax/diagnostic.rs:127



failures:
    Control_structures_7

test result: FAILED. 133 passed; 1 failed; 27 ignored; 0 measured

task '<main>' failed at 'Some tests failed', /Users/rustbuild/src/rust-buildbot/slave/nightly-mac/build/src/libtest/lib.rs:243

[steveklabnik]

Weird. @alexcrichton , does make not run the doc tests? what should I be running?

[alexcrichton]

make check will run everything, but make check-stage2-doc is probably what you want to run for the guides/markdown files.

[steveklabnik]

Okay, I've added the ignore, and also added the extra few words @pnkfelix suggested.

When I ran rustdoc --test, there were two unrelated failures. Let's see what Travis says.

[alexcrichton]

r=me with a squash

[steveklabnik]

Squashed.