Skip to content

Commit

Permalink
Rollup merge of rust-lang#76642 - GuillaumeGomez:ignored-private-doc-…
Browse files Browse the repository at this point in the history
…test, r=jyn514

Ignored private doc test

Fixes rust-lang#76457.

r? @ehuss
  • Loading branch information
Dylan-DPC authored Sep 16, 2020
2 parents 0224a3e + 15d25a8 commit b0e36db
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
16 changes: 6 additions & 10 deletions src/librustdoc/passes/doc_test_lints.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::clean;
use crate::clean::*;
use crate::core::DocContext;
use crate::fold::DocFolder;
use crate::html::markdown::{find_testable_code, ErrorCodes, LangString};
use crate::html::markdown::{find_testable_code, ErrorCodes, Ignore, LangString};
use rustc_session::lint;

pub const CHECK_PRIVATE_ITEMS_DOC_TESTS: Pass = Pass {
Expand Down Expand Up @@ -48,15 +48,11 @@ pub(crate) struct Tests {
pub(crate) found_tests: usize,
}

impl Tests {
pub(crate) fn new() -> Tests {
Tests { found_tests: 0 }
}
}

impl crate::doctest::Tester for Tests {
fn add_test(&mut self, _: String, _: LangString, _: usize) {
self.found_tests += 1;
fn add_test(&mut self, _: String, config: LangString, _: usize) {
if config.rust && config.ignore == Ignore::None {
self.found_tests += 1;
}
}
}

Expand Down Expand Up @@ -85,7 +81,7 @@ pub fn look_for_tests<'tcx>(cx: &DocContext<'tcx>, dox: &str, item: &Item) {
}
};

let mut tests = Tests::new();
let mut tests = Tests { found_tests: 0 };

find_testable_code(&dox, &mut tests, ErrorCodes::No, false, None);

Expand Down
4 changes: 2 additions & 2 deletions src/test/rustdoc-ui/coverage/doc-examples.stdout
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+-------------------------------------+------------+------------+------------+------------+
| File | Documented | Percentage | Examples | Percentage |
+-------------------------------------+------------+------------+------------+------------+
| ...tdoc-ui/coverage/doc-examples.rs | 4 | 100.0% | 2 | 50.0% |
| ...tdoc-ui/coverage/doc-examples.rs | 4 | 100.0% | 1 | 25.0% |
+-------------------------------------+------------+------------+------------+------------+
| Total | 4 | 100.0% | 2 | 50.0% |
| Total | 4 | 100.0% | 1 | 25.0% |
+-------------------------------------+------------+------------+------------+------------+
12 changes: 12 additions & 0 deletions src/test/rustdoc-ui/private-doc-test.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// check-pass

#![deny(private_doc_tests)]

mod foo {
/// private doc test
///
/// ```ignore (used for testing ignored doc tests)
/// assert!(false);
/// ```
fn bar() {}
}

0 comments on commit b0e36db

Please sign in to comment.