-
Notifications
You must be signed in to change notification settings - Fork 12.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #74855 - jyn514:separate-lints, r=Manishearth
Separate `missing_doc_code_examples` from intra-doc links These two lints have no relation other than both being nightly-only. This allows stabilizing intra-doc links without stabilizing `missing_doc_code_examples`. Fixes one of the issues spotted by @ollie27 in #74430 (comment). r? @Manishearth
- Loading branch information
Showing
5 changed files
with
113 additions
and
103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| //! This pass is overloaded and runs two different lints. | ||
| //! | ||
| //! - MISSING_DOC_CODE_EXAMPLES: this looks for public items missing doc-tests | ||
| //! - PRIVATE_DOC_TESTS: this looks for private items with doc-tests. | ||
| use super::{span_of_attrs, Pass}; | ||
| use crate::clean::*; | ||
| use crate::core::DocContext; | ||
| use crate::fold::DocFolder; | ||
| use crate::html::markdown::{find_testable_code, ErrorCodes, LangString}; | ||
| use rustc_session::lint; | ||
|
|
||
| pub const CHECK_PRIVATE_ITEMS_DOC_TESTS: Pass = Pass { | ||
| name: "check-private-items-doc-tests", | ||
| run: check_private_items_doc_tests, | ||
| description: "check private items doc tests", | ||
| }; | ||
|
|
||
| struct PrivateItemDocTestLinter<'a, 'tcx> { | ||
| cx: &'a DocContext<'tcx>, | ||
| } | ||
|
|
||
| impl<'a, 'tcx> PrivateItemDocTestLinter<'a, 'tcx> { | ||
| fn new(cx: &'a DocContext<'tcx>) -> Self { | ||
| PrivateItemDocTestLinter { cx } | ||
| } | ||
| } | ||
|
|
||
| pub fn check_private_items_doc_tests(krate: Crate, cx: &DocContext<'_>) -> Crate { | ||
| let mut coll = PrivateItemDocTestLinter::new(cx); | ||
|
|
||
| coll.fold_crate(krate) | ||
| } | ||
|
|
||
| impl<'a, 'tcx> DocFolder for PrivateItemDocTestLinter<'a, 'tcx> { | ||
| fn fold_item(&mut self, item: Item) -> Option<Item> { | ||
| let cx = self.cx; | ||
| let dox = item.attrs.collapsed_doc_value().unwrap_or_else(String::new); | ||
|
|
||
| look_for_tests(&cx, &dox, &item); | ||
|
|
||
| self.fold_item_recur(item) | ||
| } | ||
| } | ||
|
|
||
| pub fn look_for_tests<'tcx>(cx: &DocContext<'tcx>, dox: &str, item: &Item) { | ||
| let hir_id = match cx.as_local_hir_id(item.def_id) { | ||
| Some(hir_id) => hir_id, | ||
| None => { | ||
| // If non-local, no need to check anything. | ||
| return; | ||
| } | ||
| }; | ||
|
|
||
| struct Tests { | ||
| found_tests: usize, | ||
| } | ||
|
|
||
| impl crate::test::Tester for Tests { | ||
| fn add_test(&mut self, _: String, _: LangString, _: usize) { | ||
| self.found_tests += 1; | ||
| } | ||
| } | ||
|
|
||
| let mut tests = Tests { found_tests: 0 }; | ||
|
|
||
| find_testable_code(&dox, &mut tests, ErrorCodes::No, false, None); | ||
|
|
||
| if tests.found_tests == 0 { | ||
| use ItemEnum::*; | ||
|
|
||
| let should_report = match item.inner { | ||
| ExternCrateItem(_, _) | ImportItem(_) | PrimitiveItem(_) | KeywordItem(_) => false, | ||
| _ => true, | ||
| }; | ||
| if should_report { | ||
| debug!("reporting error for {:?} (hir_id={:?})", item, hir_id); | ||
| let sp = span_of_attrs(&item.attrs).unwrap_or(item.source.span()); | ||
| cx.tcx.struct_span_lint_hir( | ||
| lint::builtin::MISSING_DOC_CODE_EXAMPLES, | ||
| hir_id, | ||
| sp, | ||
| |lint| lint.build("missing code example in this documentation").emit(), | ||
| ); | ||
| } | ||
| } else if rustc_feature::UnstableFeatures::from_environment().is_nightly_build() | ||
| && tests.found_tests > 0 | ||
| && !cx.renderinfo.borrow().access_levels.is_public(item.def_id) | ||
| { | ||
| cx.tcx.struct_span_lint_hir( | ||
| lint::builtin::PRIVATE_DOC_TESTS, | ||
| hir_id, | ||
| span_of_attrs(&item.attrs).unwrap_or(item.source.span()), | ||
| |lint| lint.build("documentation test in private item").emit(), | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters