squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Auto merge of #5023 - rust-lang:doc-main, r=phansch

Browse source 
Omit doc safety/errors header checking for main

This omits checking `main` methods, which are not usually documented in the way the others are.

changelog: none
This commit is contained in:
bors 2020-01-14 21:21:58 +00:00
commit 5ab50d20a6
2 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
clippy_lints/src/doc.rs
View file

@ -1,4 +1,4 @@
use crate::utils::{match_type, paths, return_ty, span_lint};
use crate::utils::{is_entrypoint_fn, match_type, paths, return_ty, span_lint};
use itertools::Itertools;
use rustc::lint::in_external_macro;
use rustc_data_structures::fx::FxHashSet;
@ -153,7 +153,9 @@ impl<'a, 'tcx> LateLintPass<'a, 'tcx> for DocMarkdown {
let headers = check_attrs(cx, &self.valid_idents, &item.attrs);
match item.kind {
hir::ItemKind::Fn(ref sig, ..) => {
if !in_external_macro(cx.tcx.sess, item.span) {
if !(is_entrypoint_fn(cx, cx.tcx.hir().local_def_id(item.hir_id))
|| in_external_macro(cx.tcx.sess, item.span))
{
lint_for_missing_headers(cx, item.hir_id, item.span, sig, headers);
}
},

4
tests/ui/doc_errors.rs
View file

@ -61,4 +61,6 @@ impl Trait1 for Struct1 {
}
}
fn main() {}
fn main() -> Result<(), ()> {
Ok(())
}