bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

rustdoc: Stop stripping empty modules

Browse source 
There is no good reason to strip empty modules with no documentation and
doing so causes subtle problems.
This commit is contained in:
Oliver Middleton 2017-06-11 13:28:45 +01:00
parent 19193d6390
commit 7298dabdb3
4 changed files with 60 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/librustdoc/html/render.rs
View file

@ -1349,7 +1349,7 @@ impl Context {
// these modules are recursed into, but not rendered normally
// (a flag on the context).
if !self.render_redirect_pages {
self.render_redirect_pages = maybe_ignore_item(&item);
self.render_redirect_pages = item.is_stripped();
}
if item.is_mod() {
@ -1432,7 +1432,7 @@ impl Context {
// BTreeMap instead of HashMap to get a sorted output
let mut map = BTreeMap::new();
for item in &m.items {
if maybe_ignore_item(item) { continue }
if item.is_stripped() { continue }
let short = item.type_().css_class();
let myname = match item.name {
@ -1733,7 +1733,7 @@ fn item_module(w: &mut fmt::Formatter, cx: &Context,
if let clean::DefaultImplItem(..) = items[*i].inner {
return false;
}
!maybe_ignore_item(&items[*i])
!items[*i].is_stripped()
}).collect::<Vec<usize>>();
// the order of item types in the listing
@ -1902,17 +1902,6 @@ fn item_module(w: &mut fmt::Formatter, cx: &Context,
Ok(())
}
fn maybe_ignore_item(it: &clean::Item) -> bool {
match it.inner {
clean::StrippedItem(..) => true,
clean::ModuleItem(ref m) => {
it.doc_value().is_none() && m.items.is_empty()
&& it.visibility != Some(clean::Public)
},
_ => false,
}
}
fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Vec<String> {
let mut stability = vec![];
@ -3332,7 +3321,7 @@ fn sidebar_module(fmt: &mut fmt::Formatter, _it: &clean::Item,
if let clean::DefaultImplItem(..) = it.inner {
false
} else {
!maybe_ignore_item(it) && !it.is_stripped() && it.type_() == myty
!it.is_stripped() && it.type_() == myty
}
}) {
let (short, name) = match myty {