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

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
rust-lang-ci · Jan 14, 2020 · 5ab50d2 · 5ab50d2
2 parents c24a422 + 2797b64
commit 5ab50d2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/clippy_lints/src/doc.rs b/clippy_lints/src/doc.rs
@@ -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);
                 }
             },

diff --git a/tests/ui/doc_errors.rs b/tests/ui/doc_errors.rs
@@ -61,4 +61,6 @@ impl Trait1 for Struct1 {
     }
 }
 
-fn main() {}
+fn main() -> Result<(), ()> {
+    Ok(())
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -61,4 +61,6 @@ impl Trait1 for Struct1 { @@
         }
     }
-    fn main() {}
+    fn main() -> Result<(), ()> {
+        Ok(())
+    }