Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-11-14 17:07:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #3657 - roblabla:bugfix-missing-docs-global-asm, r=phansch

Browse source 
Missing docs: don't require documenting Global Asm items.

global_asm! items cannot be documented, the lint still gets triggered after adding documentation to the macro invocation. Furthermore, even if we could add documentation to the AST node, rustdoc doesn't render it anyways.

Playground example: https://play.rust-lang.org/?version=nightly&mode=debug&edition=2018&gist=5182df182f0ffbbab4c3107e43368ac3
This commit is contained in:
bors 2019-01-14 14:50:27 +00:00
commit 19553aee2c
2 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
clippy_lints/src/missing_doc.rs
View file

@ -133,12 +133,12 @@ impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingDoc {
hir::ItemKind::Struct(..) => "a struct", hir::ItemKind::Struct(..) => "a struct",
hir::ItemKind::Trait(..) => "a trait", hir::ItemKind::Trait(..) => "a trait",
hir::ItemKind::TraitAlias(..) => "a trait alias", hir::ItemKind::TraitAlias(..) => "a trait alias",
hir::ItemKind::GlobalAsm(..) => "an assembly blob",
hir::ItemKind::Ty(..) => "a type alias", hir::ItemKind::Ty(..) => "a type alias",
hir::ItemKind::Union(..) => "a union", hir::ItemKind::Union(..) => "a union",
hir::ItemKind::Existential(..) => "an existential type", hir::ItemKind::Existential(..) => "an existential type",
hir::ItemKind::ExternCrate(..) hir::ItemKind::ExternCrate(..)
| hir::ItemKind::ForeignMod(..) | hir::ItemKind::ForeignMod(..)
| hir::ItemKind::GlobalAsm(..)
| hir::ItemKind::Impl(..) | hir::ItemKind::Impl(..)
| hir::ItemKind::Use(..) => return, | hir::ItemKind::Use(..) => return,
}; };

5
tests/ui/missing-doc.rs
View file

@ -2,7 +2,7 @@
// When denying at the crate level, be sure to not get random warnings from the // When denying at the crate level, be sure to not get random warnings from the
// injected intrinsics by the compiler. // injected intrinsics by the compiler.
#![allow(dead_code)] #![allow(dead_code)]
#![feature(associated_type_defaults)] #![feature(associated_type_defaults, global_asm)]
//! Some garbage docs for the crate here //! Some garbage docs for the crate here
#![doc = "More garbage"] #![doc = "More garbage"]
@ -176,3 +176,6 @@ pub mod public_interface {
} }
fn main() {} fn main() {}
// Ensure global asm doesn't require documentation.
global_asm! { "" }