Skip to content

Commit 3ee4629

Browse files
camelidGuillaumeGomez
authored andcommitted
rustdoc: Rename Tester to DoctestVisitor
The new name more accurately captures what it is.
1 parent 1be24d7 commit 3ee4629

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

src/librustdoc/doctest.rs

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

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

994994
pub(crate) struct Collector {
@@ -1091,8 +1091,8 @@ impl Collector {
10911091
}
10921092
}
10931093

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

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

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

src/librustdoc/html/markdown.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,7 @@ impl<'a, I: Iterator<Item = SpannedEvent<'a>>> Iterator for Footnotes<'a, I> {
710710
}
711711
}
712712

713-
pub(crate) fn find_testable_code<T: doctest::Tester>(
713+
pub(crate) fn find_testable_code<T: doctest::DoctestVisitor>(
714714
doc: &str,
715715
tests: &mut T,
716716
error_codes: ErrorCodes,
@@ -720,7 +720,7 @@ pub(crate) fn find_testable_code<T: doctest::Tester>(
720720
find_codes(doc, tests, error_codes, enable_per_target_ignores, extra_info, false)
721721
}
722722

723-
pub(crate) fn find_codes<T: doctest::Tester>(
723+
pub(crate) fn find_codes<T: doctest::DoctestVisitor>(
724724
doc: &str,
725725
tests: &mut T,
726726
error_codes: ErrorCodes,
@@ -773,15 +773,15 @@ pub(crate) fn find_codes<T: doctest::Tester>(
773773
nb_lines -= 1;
774774
}
775775
let line = tests.get_line() + nb_lines + 1;
776-
tests.add_test(text, block_info, line);
776+
tests.visit_test(text, block_info, line);
777777
prev_offset = offset.start;
778778
}
779779
Event::Start(Tag::Heading(level, _, _)) => {
780780
register_header = Some(level as u32);
781781
}
782782
Event::Text(ref s) if register_header.is_some() => {
783783
let level = register_header.unwrap();
784-
tests.register_header(s, level);
784+
tests.visit_header(s, level);
785785
register_header = None;
786786
}
787787
_ => {}

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)