Skip to content

Commit 17a8cc5

Browse files
committed
rustdoc: Rename Tester to DoctestVisitor
The new name more accurately captures what it is.
1 parent debd22d commit 17a8cc5

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

src/librustdoc/doctest.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -984,12 +984,12 @@ impl IndividualTestOptions {
984984
}
985985
}
986986

987-
pub(crate) trait Tester {
988-
fn add_test(&mut self, test: String, config: LangString, line: usize);
987+
pub(crate) trait DoctestVisitor {
988+
fn visit_test(&mut self, test: String, config: LangString, line: usize);
989989
fn get_line(&self) -> usize {
990990
0
991991
}
992-
fn register_header(&mut self, _name: &str, _level: u32) {}
992+
fn visit_header(&mut self, _name: &str, _level: u32) {}
993993
}
994994

995995
pub(crate) struct Collector {
@@ -1092,8 +1092,8 @@ impl Collector {
10921092
}
10931093
}
10941094

1095-
impl Tester for Collector {
1096-
fn add_test(&mut self, test: String, config: LangString, line: usize) {
1095+
impl DoctestVisitor for Collector {
1096+
fn visit_test(&mut self, test: String, config: LangString, line: usize) {
10971097
let filename = self.get_filename();
10981098
let name = self.generate_name(line, &filename);
10991099
let crate_name = self.crate_name.clone();
@@ -1243,7 +1243,7 @@ impl Tester for Collector {
12431243
}
12441244
}
12451245

1246-
fn register_header(&mut self, name: &str, level: u32) {
1246+
fn visit_header(&mut self, name: &str, level: u32) {
12471247
if self.use_headers {
12481248
// We use these headings as test names, so it's good if
12491249
// they're valid identifiers.
@@ -1288,8 +1288,8 @@ impl Tester for Collector {
12881288
}
12891289

12901290
#[cfg(test)] // used in tests
1291-
impl Tester for Vec<usize> {
1292-
fn add_test(&mut self, _test: String, _config: LangString, line: usize) {
1291+
impl DoctestVisitor for Vec<usize> {
1292+
fn visit_test(&mut self, _test: String, _config: LangString, line: usize) {
12931293
self.push(line);
12941294
}
12951295
}

src/librustdoc/html/markdown.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -727,7 +727,7 @@ impl<'a, I: Iterator<Item = SpannedEvent<'a>>> Iterator for Footnotes<'a, I> {
727727
}
728728
}
729729

730-
pub(crate) fn find_testable_code<T: doctest::Tester>(
730+
pub(crate) fn find_testable_code<T: doctest::DoctestVisitor>(
731731
doc: &str,
732732
tests: &mut T,
733733
error_codes: ErrorCodes,
@@ -746,7 +746,7 @@ pub(crate) fn find_testable_code<T: doctest::Tester>(
746746
)
747747
}
748748

749-
pub(crate) fn find_codes<T: doctest::Tester>(
749+
pub(crate) fn find_codes<T: doctest::DoctestVisitor>(
750750
doc: &str,
751751
tests: &mut T,
752752
error_codes: ErrorCodes,
@@ -801,15 +801,15 @@ pub(crate) fn find_codes<T: doctest::Tester>(
801801
nb_lines -= 1;
802802
}
803803
let line = tests.get_line() + nb_lines + 1;
804-
tests.add_test(text, block_info, line);
804+
tests.visit_test(text, block_info, line);
805805
prev_offset = offset.start;
806806
}
807807
Event::Start(Tag::Heading(level, _, _)) => {
808808
register_header = Some(level as u32);
809809
}
810810
Event::Text(ref s) if register_header.is_some() => {
811811
let level = register_header.unwrap();
812-
tests.register_header(s, level);
812+
tests.visit_header(s, level);
813813
register_header = None;
814814
}
815815
_ => {}

src/librustdoc/passes/check_custom_code_classes.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ struct TestsWithCustomClasses {
4646
custom_classes_found: Vec<String>,
4747
}
4848

49-
impl crate::doctest::Tester for TestsWithCustomClasses {
50-
fn add_test(&mut self, _: String, config: LangString, _: usize) {
49+
impl crate::doctest::DoctestVisitor for TestsWithCustomClasses {
50+
fn visit_test(&mut self, _: String, config: LangString, _: usize) {
5151
self.custom_classes_found.extend(config.added_classes);
5252
}
5353
}

src/librustdoc/passes/check_doc_test_visibility.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ pub(crate) struct Tests {
4444
pub(crate) found_tests: usize,
4545
}
4646

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

0 commit comments

Comments
 (0)