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.

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

Remove missing_docs lint on private 2.0 macros #86968

Merged
merged 3 commits into from
Jul 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions compiler/rustc_lint/src/builtin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,12 @@ impl<'tcx> LateLintPass<'tcx> for MissingDoc {
self.check_missing_docs_attrs(cx, hir::CRATE_HIR_ID, krate.item.inner, "the", "crate");

for macro_def in krate.exported_macros {
// Non exported macros should be skipped, since `missing_docs` only
// applies to externally visible items.
if !cx.access_levels.is_exported(macro_def.hir_id()) {
continue;
}

let attrs = cx.tcx.hir().attrs(macro_def.hir_id());
let has_doc = attrs.iter().any(|a| has_doc(cx.sess(), a));
if !has_doc {
Expand Down
43 changes: 43 additions & 0 deletions src/test/ui/lint/missing-doc-private-macro.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Checks that undocumented private macros will not generate `missing_docs`
// lints, but public ones will.
//
// This is a regression test for issue #57569
#![deny(missing_docs)]
#![feature(decl_macro)]
//! Empty documentation.

macro new_style_private_macro {
() => ()
}

pub(crate) macro new_style_crate_macro {
() => ()
}

macro_rules! old_style_private_macro {
() => ()
}

mod submodule {
pub macro new_style_macro_in_private_module {
() => ()
}

macro_rules! old_style_mod_private_macro {
() => ()
}

#[macro_export]
macro_rules! exported_to_top_level {
//~^ ERROR missing documentation for macro
() => ()
}
}

pub macro top_level_pub_macro {
//~^ ERROR missing documentation for macro
() => ()
}

/// Empty documentation.
pub fn main() {}
20 changes: 20 additions & 0 deletions src/test/ui/lint/missing-doc-private-macro.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
error: missing documentation for macro
--> $DIR/missing-doc-private-macro.rs:31:5
|
LL | macro_rules! exported_to_top_level {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
note: the lint level is defined here
--> $DIR/missing-doc-private-macro.rs:5:9
|
LL | #![deny(missing_docs)]
| ^^^^^^^^^^^^

error: missing documentation for macro
--> $DIR/missing-doc-private-macro.rs:37:1
|
LL | pub macro top_level_pub_macro {
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: aborting due to 2 previous errors