Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prevent emitting missing_docs for pub extern crate #112343

Merged
merged 2 commits into from
Jun 7, 2023
Merged

Prevent emitting missing_docs for pub extern crate #112343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4711c30
Prevent emitting `missing_docs` for `pub extern crate`
GuillaumeGomez Jun 6, 2023
550fe63
Add regression test for #112308
GuillaumeGomez Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions compiler/rustc_lint/src/builtin.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,8 +548,12 @@ impl<'tcx> LateLintPass<'tcx> for MissingDoc {

fn check_item(&mut self, cx: &LateContext<'_>, it: &hir::Item<'_>) {
// Previously the Impl and Use types have been excluded from missing docs,
// so we will continue to exclude them for compatibility
if let hir::ItemKind::Impl(..) | hir::ItemKind::Use(..) = it.kind {
// so we will continue to exclude them for compatibility.
//
// The documentation on `ExternCrate` is not used at the moment so no need to warn for it.
if let hir::ItemKind::Impl(..) | hir::ItemKind::Use(..) | hir::ItemKind::ExternCrate(_) =
it.kind
{
return;
}

Expand Down
1 change: 1 addition & 0 deletions tests/ui/lint/auxiliary/missing_docs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pub struct Foo;
4 changes: 4 additions & 0 deletions tests/ui/lint/lint-missing-doc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// When denying at the crate level, be sure to not get random warnings from the
// injected intrinsics by the compiler.
// aux-build:missing_docs.rs
#![deny(missing_docs)]
#![allow(dead_code)]
#![feature(associated_type_defaults, extern_types)]
Expand All @@ -8,6 +9,9 @@
//! Some garbage docs for the crate here
#![doc="More garbage"]

// There should be not "missing_docs" warning on "pub extern crate".
pub extern crate missing_docs;

type Typedef = String;
pub type PubTypedef = String; //~ ERROR: missing documentation for a type alias

Expand Down
52 changes: 26 additions & 26 deletions tests/ui/lint/lint-missing-doc.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,155 +1,155 @@
error: missing documentation for a type alias
--> $DIR/lint-missing-doc.rs:12:1
--> $DIR/lint-missing-doc.rs:16:1
|
LL | pub type PubTypedef = String;
| ^^^^^^^^^^^^^^^^^^^
|
note: the lint level is defined here
--> $DIR/lint-missing-doc.rs:3:9
--> $DIR/lint-missing-doc.rs:4:9
|
LL | #![deny(missing_docs)]
| ^^^^^^^^^^^^

error: missing documentation for a struct
--> $DIR/lint-missing-doc.rs:19:1
--> $DIR/lint-missing-doc.rs:23:1
|
LL | pub struct PubFoo {
| ^^^^^^^^^^^^^^^^^

error: missing documentation for a struct field
--> $DIR/lint-missing-doc.rs:20:5
--> $DIR/lint-missing-doc.rs:24:5
|
LL | pub a: isize,
| ^^^^^^^^^^^^

error: missing documentation for a module
--> $DIR/lint-missing-doc.rs:31:1
--> $DIR/lint-missing-doc.rs:35:1
|
LL | pub mod pub_module_no_dox {}
| ^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
--> $DIR/lint-missing-doc.rs:35:1
--> $DIR/lint-missing-doc.rs:39:1
|
LL | pub fn foo2() {}
| ^^^^^^^^^^^^^

error: missing documentation for a trait
--> $DIR/lint-missing-doc.rs:53:1
--> $DIR/lint-missing-doc.rs:57:1
|
LL | pub trait C {
| ^^^^^^^^^^^

error: missing documentation for a method
--> $DIR/lint-missing-doc.rs:54:5
--> $DIR/lint-missing-doc.rs:58:5
|
LL | fn foo(&self);
| ^^^^^^^^^^^^^^

error: missing documentation for a method
--> $DIR/lint-missing-doc.rs:55:5
--> $DIR/lint-missing-doc.rs:59:5
|
LL | fn foo_with_impl(&self) {}
| ^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for an associated function
--> $DIR/lint-missing-doc.rs:56:5
--> $DIR/lint-missing-doc.rs:60:5
|
LL | fn foo_no_self();
| ^^^^^^^^^^^^^^^^^

error: missing documentation for an associated function
--> $DIR/lint-missing-doc.rs:57:5
--> $DIR/lint-missing-doc.rs:61:5
|
LL | fn foo_no_self_with_impl() {}
| ^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for an associated type
--> $DIR/lint-missing-doc.rs:67:5
--> $DIR/lint-missing-doc.rs:71:5
|
LL | type AssociatedType;
| ^^^^^^^^^^^^^^^^^^^

error: missing documentation for an associated type
--> $DIR/lint-missing-doc.rs:68:5
--> $DIR/lint-missing-doc.rs:72:5
|
LL | type AssociatedTypeDef = Self;
| ^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for an associated function
--> $DIR/lint-missing-doc.rs:84:5
--> $DIR/lint-missing-doc.rs:88:5
|
LL | pub fn foo() {}
| ^^^^^^^^^^^^

error: missing documentation for an enum
--> $DIR/lint-missing-doc.rs:121:1
--> $DIR/lint-missing-doc.rs:125:1
|
LL | pub enum PubBaz {
| ^^^^^^^^^^^^^^^

error: missing documentation for a variant
--> $DIR/lint-missing-doc.rs:122:5
--> $DIR/lint-missing-doc.rs:126:5
|
LL | PubBazA {
| ^^^^^^^

error: missing documentation for a struct field
--> $DIR/lint-missing-doc.rs:123:9
--> $DIR/lint-missing-doc.rs:127:9
|
LL | a: isize,
| ^^^^^^^^

error: missing documentation for a constant
--> $DIR/lint-missing-doc.rs:154:1
--> $DIR/lint-missing-doc.rs:158:1
|
LL | pub const FOO4: u32 = 0;
| ^^^^^^^^^^^^^^^^^^^

error: missing documentation for a static
--> $DIR/lint-missing-doc.rs:164:1
--> $DIR/lint-missing-doc.rs:168:1
|
LL | pub static BAR4: u32 = 0;
| ^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
--> $DIR/lint-missing-doc.rs:170:5
--> $DIR/lint-missing-doc.rs:174:5
|
LL | pub fn undocumented1() {}
| ^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
--> $DIR/lint-missing-doc.rs:171:5
--> $DIR/lint-missing-doc.rs:175:5
|
LL | pub fn undocumented2() {}
| ^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
--> $DIR/lint-missing-doc.rs:177:9
--> $DIR/lint-missing-doc.rs:181:9
|
LL | pub fn also_undocumented1() {}
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a function
--> $DIR/lint-missing-doc.rs:192:5
--> $DIR/lint-missing-doc.rs:196:5
|
LL | pub fn extern_fn_undocumented(f: f32) -> f32;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a static
--> $DIR/lint-missing-doc.rs:197:5
--> $DIR/lint-missing-doc.rs:201:5
|
LL | pub static EXTERN_STATIC_UNDOCUMENTED: u8;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a foreign type
--> $DIR/lint-missing-doc.rs:202:5
--> $DIR/lint-missing-doc.rs:206:5
|
LL | pub type ExternTyUndocumented;
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: missing documentation for a trait alias
--> $DIR/lint-missing-doc.rs:206:1
--> $DIR/lint-missing-doc.rs:210:1
|
LL | pub trait T = Sync;
| ^^^^^^^^^^^
Expand Down