-
Notifications
You must be signed in to change notification settings - Fork 12.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rollup merge of #92349 - avitex:fix-rustdoc-private-doc-tests, r=Guil…
…laumeGomez Fix rustdoc::private_doc_tests lint for public re-exported items Closes #72081 This involves changing the lint to check the access level is exported, rather than public. The [exported access level](https://github.com/rust-lang/rust/blob/e91ad5fc62bdee4a29c18baa5fad2ca42fc91bf4/compiler/rustc_middle/src/middle/privacy.rs#L24) accounts for public items and items accessible to other crates with the help of `pub use` re-exports. The pattern of re-exporting public items from a private module is usage seen in a number of popular crates.
- Loading branch information
Showing
4 changed files
with
46 additions
and
1 deletion.
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,11 @@ | ||
#![deny(rustdoc::private_doc_tests)] | ||
|
||
mod foo { | ||
/// private doc test | ||
/// | ||
/// ``` | ||
/// assert!(false); | ||
/// ``` | ||
//~^^^^^ ERROR documentation test in private item | ||
pub fn bar() {} | ||
} |
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,18 @@ | ||
error: documentation test in private item | ||
--> $DIR/private-public-item-doc-test.rs:4:5 | ||
| | ||
LL | / /// private doc test | ||
LL | | /// | ||
LL | | /// ``` | ||
LL | | /// assert!(false); | ||
LL | | /// ``` | ||
| |___________^ | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/private-public-item-doc-test.rs:1:9 | ||
| | ||
LL | #![deny(rustdoc::private_doc_tests)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
error: aborting due to previous error | ||
|
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,16 @@ | ||
// check-pass | ||
|
||
#![deny(rustdoc::private_doc_tests)] | ||
|
||
pub fn foo() {} | ||
|
||
mod private { | ||
/// re-exported doc test | ||
/// | ||
/// ``` | ||
/// assert!(true); | ||
/// ``` | ||
pub fn bar() {} | ||
} | ||
|
||
pub use private::bar; |