From 5f96c48de26a029727483b6f14f0ca2e5067da19 Mon Sep 17 00:00:00 2001
From: Camelid <camelidcamel@gmail.com>
Date: Thu, 1 Apr 2021 13:26:29 -0700
Subject: [PATCH 1/2] rustdoc: Rename internal uses of `spotlight`
I didn't make these renames in #80965 because I didn't want the PR to
conflict with #80914.
---
src/librustdoc/clean/inline.rs | 2 +-
src/librustdoc/clean/types.rs | 2 +-
src/librustdoc/core.rs | 7 +++----
src/librustdoc/formats/cache.rs | 4 ++--
src/librustdoc/html/render/mod.rs | 14 ++++++++------
src/librustdoc/html/render/print_item.rs | 10 +++++-----
6 files changed, 20 insertions(+), 19 deletions(-)
diff --git a/src/librustdoc/clean/inline.rs b/src/librustdoc/clean/inline.rs
index 1e9a7d1b4b9ad..277ec91f15ed7 100644
--- a/src/librustdoc/clean/inline.rs
+++ b/src/librustdoc/clean/inline.rs
@@ -624,7 +624,7 @@ crate fn record_extern_trait(cx: &mut DocContext<'_>, did: DefId) {
let trait_ = clean::TraitWithExtraInfo {
trait_,
- is_spotlight: clean::utils::has_doc_flag(cx.tcx.get_attrs(did), sym::notable_trait),
+ is_notable: clean::utils::has_doc_flag(cx.tcx.get_attrs(did), sym::notable_trait),
};
cx.external_traits.borrow_mut().insert(did, trait_);
cx.active_extern_traits.remove(&did);
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
index 4132e187c72a1..95d9ff98aed21 100644
--- a/src/librustdoc/clean/types.rs
+++ b/src/librustdoc/clean/types.rs
@@ -65,7 +65,7 @@ crate struct Crate {
#[derive(Clone, Debug)]
crate struct TraitWithExtraInfo {
crate trait_: Trait,
- crate is_spotlight: bool,
+ crate is_notable: bool,
}
#[derive(Clone, Debug)]
diff --git a/src/librustdoc/core.rs b/src/librustdoc/core.rs
index 5a022b2d40c56..dae7980130cf7 100644
--- a/src/librustdoc/core.rs
+++ b/src/librustdoc/core.rs
@@ -464,10 +464,9 @@ crate fn run_global_ctxt(
if let Some(sized_trait_did) = ctxt.tcx.lang_items().sized_trait() {
let mut sized_trait = build_external_trait(&mut ctxt, sized_trait_did);
sized_trait.is_auto = true;
- ctxt.external_traits.borrow_mut().insert(
- sized_trait_did,
- TraitWithExtraInfo { trait_: sized_trait, is_spotlight: false },
- );
+ ctxt.external_traits
+ .borrow_mut()
+ .insert(sized_trait_did, TraitWithExtraInfo { trait_: sized_trait, is_notable: false });
}
debug!("crate: {:?}", tcx.hir().krate());
diff --git a/src/librustdoc/formats/cache.rs b/src/librustdoc/formats/cache.rs
index 01bceb1d910ca..0e405d6ae028e 100644
--- a/src/librustdoc/formats/cache.rs
+++ b/src/librustdoc/formats/cache.rs
@@ -116,7 +116,7 @@ crate struct Cache {
// even though the trait itself is not exported. This can happen if a trait
// was defined in function/expression scope, since the impl will be picked
// up by `collect-trait-impls` but the trait won't be scraped out in the HIR
- // crawl. In order to prevent crashes when looking for spotlight traits or
+ // crawl. In order to prevent crashes when looking for notable traits or
// when gathering trait documentation on a type, hold impls here while
// folding and add them to the cache later on if we find the trait.
orphan_trait_impls: Vec<(DefId, FxHashSet<DefId>, Impl)>,
@@ -227,7 +227,7 @@ impl<'a, 'tcx> DocFolder for CacheBuilder<'a, 'tcx> {
if let clean::TraitItem(ref t) = *item.kind {
self.cache.traits.entry(item.def_id).or_insert_with(|| clean::TraitWithExtraInfo {
trait_: t.clone(),
- is_spotlight: item.attrs.has_doc_flag(sym::notable_trait),
+ is_notable: item.attrs.has_doc_flag(sym::notable_trait),
});
}
diff --git a/src/librustdoc/html/render/mod.rs b/src/librustdoc/html/render/mod.rs
index 07bd26a4c5ebe..a8a08fb23e08f 100644
--- a/src/librustdoc/html/render/mod.rs
+++ b/src/librustdoc/html/render/mod.rs
@@ -1045,7 +1045,7 @@ fn render_assoc_item(
write!(
w,
"{}{}{}{}{}{}{}fn <a href=\"{href}\" class=\"fnname\">{name}</a>\
- {generics}{decl}{spotlight}{where_clause}",
+ {generics}{decl}{notable_traits}{where_clause}",
if parent == ItemType::Trait { " " } else { "" },
vis,
constness,
@@ -1057,7 +1057,7 @@ fn render_assoc_item(
name = name,
generics = g.print(cache, tcx),
decl = d.full_print(cache, tcx, header_len, indent, header.asyncness),
- spotlight = spotlight_decl(&d, cache, tcx),
+ notable_traits = notable_traits_decl(&d, cache, tcx),
where_clause = print_where_clause(g, cache, tcx, indent, end_newline),
)
}
@@ -1341,7 +1341,7 @@ fn should_render_item(item: &clean::Item, deref_mut_: bool, cache: &Cache) -> bo
}
}
-fn spotlight_decl(decl: &clean::FnDecl, cache: &Cache, tcx: TyCtxt<'_>) -> String {
+fn notable_traits_decl(decl: &clean::FnDecl, cache: &Cache, tcx: TyCtxt<'_>) -> String {
let mut out = Buffer::html();
let mut trait_ = String::new();
@@ -1349,9 +1349,11 @@ fn spotlight_decl(decl: &clean::FnDecl, cache: &Cache, tcx: TyCtxt<'_>) -> Strin
if let Some(impls) = cache.impls.get(&did) {
for i in impls {
let impl_ = i.inner_impl();
- if impl_.trait_.def_id().map_or(false, |d| {
- cache.traits.get(&d).map(|t| t.is_spotlight).unwrap_or(false)
- }) {
+ if impl_
+ .trait_
+ .def_id()
+ .map_or(false, |d| cache.traits.get(&d).map(|t| t.is_notable).unwrap_or(false))
+ {
if out.is_empty() {
write!(
&mut out,
diff --git a/src/librustdoc/html/render/print_item.rs b/src/librustdoc/html/render/print_item.rs
index 25314f87eb5ae..0cdfe435b9c93 100644
--- a/src/librustdoc/html/render/print_item.rs
+++ b/src/librustdoc/html/render/print_item.rs
@@ -10,9 +10,9 @@ use rustc_span::hygiene::MacroKind;
use rustc_span::symbol::{kw, sym, Symbol};
use super::{
- collect_paths_for_type, document, ensure_trailing_slash, item_ty_to_strs, render_assoc_item,
- render_assoc_items, render_attributes, render_impl, render_stability_since_raw, spotlight_decl,
- write_srclink, AssocItemLink, Context,
+ collect_paths_for_type, document, ensure_trailing_slash, item_ty_to_strs, notable_traits_decl,
+ render_assoc_item, render_assoc_items, render_attributes, render_impl,
+ render_stability_since_raw, write_srclink, AssocItemLink, Context,
};
use crate::clean::{self, GetDefId};
use crate::formats::cache::Cache;
@@ -381,7 +381,7 @@ fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::
write!(
w,
"{vis}{constness}{asyncness}{unsafety}{abi}fn \
- {name}{generics}{decl}{spotlight}{where_clause}</pre>",
+ {name}{generics}{decl}{notable_traits}{where_clause}</pre>",
vis = it.visibility.print_with_space(cx.tcx(), it.def_id, cx.cache()),
constness = f.header.constness.print_with_space(),
asyncness = f.header.asyncness.print_with_space(),
@@ -391,7 +391,7 @@ fn item_function(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, f: &clean::
generics = f.generics.print(cx.cache(), cx.tcx()),
where_clause = print_where_clause(&f.generics, cx.cache(), cx.tcx(), 0, true),
decl = f.decl.full_print(cx.cache(), cx.tcx(), header_len, 0, f.header.asyncness),
- spotlight = spotlight_decl(&f.decl, cx.cache(), cx.tcx()),
+ notable_traits = notable_traits_decl(&f.decl, cx.cache(), cx.tcx()),
);
document(w, cx, it, None)
}
From 1fe0fe47fcd88c67887b45293351a653b548e86a Mon Sep 17 00:00:00 2001
From: Camelid <camelidcamel@gmail.com>
Date: Thu, 1 Apr 2021 13:31:55 -0700
Subject: [PATCH 2/2] rustdoc: Remove unused `spotlight` CSS
I couldn't find any uses of this CSS. I think it was superseded by the
`.notable-traits` CSS class and other similarly-named CSS classes.
---
src/librustdoc/html/static/rustdoc.css | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/src/librustdoc/html/static/rustdoc.css b/src/librustdoc/html/static/rustdoc.css
index 07dfb7f5cf018..f3ddd8ec6fab7 100644
--- a/src/librustdoc/html/static/rustdoc.css
+++ b/src/librustdoc/html/static/rustdoc.css
@@ -173,13 +173,10 @@ code, pre, a.test-arrow {
border-radius: 3px;
padding: 0 0.1em;
}
-.docblock pre code, .docblock-short pre code, .docblock code.spotlight {
+.docblock pre code, .docblock-short pre code {
padding: 0;
padding-right: 1ex;
}
-.docblock code.spotlight :last-child {
- padding-bottom: 0.6em;
-}
pre {
padding: 14px;
}