bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Auto merge of #54349 - GuillaumeGomez:no-example-lint, r=QuietMisdreavus

Browse source 
[rustdoc] Add lint for doc without codeblocks

Fixes #53805.

r? @QuietMisdreavus
This commit is contained in:
bors 2018-10-18 09:53:29 +00:00
commit 40123a1257
7 changed files with 142 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

60
src/librustdoc/test.rs
View file

@ -465,6 +465,14 @@ fn partition_source(s: &str) -> (String, String) {
(before, after)
}
pub trait Tester {
fn add_test(&mut self, test: String, config: LangString, line: usize);
fn get_line(&self) -> usize {
0
}
fn register_header(&mut self, _name: &str, _level: u32) {}
}
pub struct Collector {
pub tests: Vec<testing::TestDescAndFn>,
@ -533,7 +541,31 @@ impl Collector {
format!("{} - {} (line {})", filename, self.names.join("::"), line)
}
pub fn add_test(&mut self, test: String, config: LangString, line: usize) {
pub fn set_position(&mut self, position: Span) {
self.position = position;
}
fn get_filename(&self) -> FileName {
if let Some(ref source_map) = self.source_map {
let filename = source_map.span_to_filename(self.position);
if let FileName::Real(ref filename) = filename {
if let Ok(cur_dir) = env::current_dir() {
if let Ok(path) = filename.strip_prefix(&cur_dir) {
return path.to_owned().into();
}
}
}
filename
} else if let Some(ref filename) = self.filename {
filename.clone().into()
} else {
FileName::Custom("input".to_owned())
}
}
}
impl Tester for Collector {
fn add_test(&mut self, test: String, config: LangString, line: usize) {
let filename = self.get_filename();
let name = self.generate_name(line, &filename);
let cfgs = self.cfgs.clone();
@ -587,7 +619,7 @@ impl Collector {
});
}
pub fn get_line(&self) -> usize {
fn get_line(&self) -> usize {
if let Some(ref source_map) = self.source_map {
let line = self.position.lo().to_usize();
let line = source_map.lookup_char_pos(BytePos(line as u32)).line;
@ -597,29 +629,7 @@ impl Collector {
}
}
pub fn set_position(&mut self, position: Span) {
self.position = position;
}
fn get_filename(&self) -> FileName {
if let Some(ref source_map) = self.source_map {
let filename = source_map.span_to_filename(self.position);
if let FileName::Real(ref filename) = filename {
if let Ok(cur_dir) = env::current_dir() {
if let Ok(path) = filename.strip_prefix(&cur_dir) {
return path.to_owned().into();
}
}
}
filename
} else if let Some(ref filename) = self.filename {
filename.clone().into()
} else {
FileName::Custom("input".to_owned())
}
}
pub fn register_header(&mut self, name: &str, level: u32) {
fn register_header(&mut self, name: &str, level: u32) {
if self.use_headers {
// we use these headings as test names, so it's good if
// they're valid identifiers.