-
Notifications
You must be signed in to change notification settings - Fork 13.4k
add a lint group for lints emitted by rustdoc #56689
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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)] | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.