Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add a lint group for lints emitted by rustdoc
- Loading branch information
1 parent
1137d29
commit 48c17a0
Showing
3 changed files
with
87 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
// 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. | ||
|
||
//! Documenting the kinds of lints emitted by rustdoc. | ||
//! | ||
//! ``` | ||
//! println!("sup"); | ||
//! ``` | ||
|
||
#![deny(rustdoc)] | ||
|
||
/// what up, let's make an [error] | ||
/// | ||
/// ``` | ||
/// println!("sup"); | ||
/// ``` | ||
pub fn link_error() {} //~^^^^^ ERROR cannot be resolved, ignoring it | ||
|
||
/// wait, this doesn't have a doctest? | ||
pub fn no_doctest() {} //~^ ERROR Missing code example in this documentation | ||
|
||
/// wait, this *does* have a doctest? | ||
/// | ||
/// ``` | ||
/// println!("sup"); | ||
/// ``` | ||
fn private_doctest() {} //~^^^^^ ERROR Documentation test in private item |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
error: Documentation test in private item | ||
--> $DIR/lint-group.rs:29:1 | ||
| | ||
LL | / /// wait, this *does* have a doctest? | ||
LL | | /// | ||
LL | | /// ``` | ||
LL | | /// println!("sup"); | ||
LL | | /// ``` | ||
| |_______^ | ||
| | ||
note: lint level defined here | ||
--> $DIR/lint-group.rs:17:9 | ||
| | ||
LL | #![deny(rustdoc)] | ||
| ^^^^^^^ | ||
= note: #[deny(private_doc_tests)] implied by #[deny(rustdoc)] | ||
|
||
error: `[error]` cannot be resolved, ignoring it... | ||
--> $DIR/lint-group.rs:19:29 | ||
| | ||
LL | /// what up, let's make an [error] | ||
| ^^^^^ cannot be resolved, ignoring | ||
| | ||
note: lint level defined here | ||
--> $DIR/lint-group.rs:17:9 | ||
| | ||
LL | #![deny(rustdoc)] | ||
| ^^^^^^^ | ||
= note: #[deny(intra_doc_link_resolution_failure)] implied by #[deny(rustdoc)] | ||
= help: to escape `[` and `]` characters, just add '/' before them like `/[` or `/]` | ||
|
||
error: Missing code example in this documentation | ||
--> $DIR/lint-group.rs:26:1 | ||
| | ||
LL | /// wait, this doesn't have a doctest? | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
| | ||
note: lint level defined here | ||
--> $DIR/lint-group.rs:17:9 | ||
| | ||
LL | #![deny(rustdoc)] | ||
| ^^^^^^^ | ||
= note: #[deny(missing_doc_code_examples)] implied by #[deny(rustdoc)] | ||
|