diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2018-10-09 16:46:29 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2018-10-09 17:55:12 +0200 |
| commit | 26479c46371db8a83760890294ac7ad051ec3467 (patch) | |
| tree | 862d1a5e780ba01b778b17816b0b20b36083f1c8 | |
| parent | 2def81a5f1d48625f74ed401329fd9af4e8668f2 (diff) | |
| download | rust-26479c46371db8a83760890294ac7ad051ec3467.tar.gz rust-26479c46371db8a83760890294ac7ad051ec3467.zip | |
Add test for docs without examples
| -rw-r--r-- | src/test/rustdoc-ui/doc-without-codeblock.rs | 20 | ||||
| -rw-r--r-- | src/test/rustdoc-ui/doc-without-codeblock.stderr | 26 |
2 files changed, 46 insertions, 0 deletions
diff --git a/src/test/rustdoc-ui/doc-without-codeblock.rs b/src/test/rustdoc-ui/doc-without-codeblock.rs new file mode 100644 index 00000000000..e047b272c41 --- /dev/null +++ b/src/test/rustdoc-ui/doc-without-codeblock.rs @@ -0,0 +1,20 @@ +// Copyright 2018 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +#![deny(missing_doc_code_examples)] + +/// Some docs. +pub struct Foo; + +/// And then, the princess died. +pub mod foo { + /// Or maybe not because she saved herself! + pub fn bar() {} +} diff --git a/src/test/rustdoc-ui/doc-without-codeblock.stderr b/src/test/rustdoc-ui/doc-without-codeblock.stderr new file mode 100644 index 00000000000..ba5bb7fc0b1 --- /dev/null +++ b/src/test/rustdoc-ui/doc-without-codeblock.stderr @@ -0,0 +1,26 @@ +error: Missing code example in this documentation + | +note: lint level defined here + --> $DIR/doc-without-codeblock.rs:11:9 + | +LL | #![deny(missing_doc_code_examples)] + | ^^^^^^^^^^^^^^^^^^^^^^^^^ + +error: Missing code example in this documentation + --> $DIR/doc-without-codeblock.rs:13:1 + | +LL | /// Some docs. + | ^^^^^^^^^^^^^^ + +error: Missing code example in this documentation + --> $DIR/doc-without-codeblock.rs:16:1 + | +LL | /// And then, the princess died. + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +error: Missing code example in this documentation + --> $DIR/doc-without-codeblock.rs:18:5 + | +LL | /// Or maybe not because she saved herself! + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + |
