mirror of
https://github.com/rust-lang/rust.git
synced 2024-10-30 22:12:15 +00:00
Rollup merge of #107490 - notriddle:notriddle/rm-sidebar-tooltip, r=GuillaumeGomez
rustdoc: remove inconsistently-present sidebar tooltips Discussed in https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/Inconsistent.20sidebar.20tooltips/near/323565625
This commit is contained in:
commit
9af90ffa3c
@ -18,7 +18,7 @@ use super::search_index::build_index;
|
||||
use super::write_shared::write_shared;
|
||||
use super::{
|
||||
collect_spans_and_sources, print_sidebar, scrape_examples_help, sidebar_module_like, AllTypes,
|
||||
LinkFromSrc, NameDoc, StylePath,
|
||||
LinkFromSrc, StylePath,
|
||||
};
|
||||
|
||||
use crate::clean::{self, types::ExternalLocation, ExternalCrate};
|
||||
@ -256,7 +256,7 @@ impl<'tcx> Context<'tcx> {
|
||||
}
|
||||
|
||||
/// Construct a map of items shown in the sidebar to a plain-text summary of their docs.
|
||||
fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
|
||||
fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<String>> {
|
||||
// BTreeMap instead of HashMap to get a sorted output
|
||||
let mut map: BTreeMap<_, Vec<_>> = BTreeMap::new();
|
||||
let mut inserted: FxHashMap<ItemType, FxHashSet<Symbol>> = FxHashMap::default();
|
||||
@ -274,10 +274,7 @@ impl<'tcx> Context<'tcx> {
|
||||
if inserted.entry(short).or_default().insert(myname) {
|
||||
let short = short.to_string();
|
||||
let myname = myname.to_string();
|
||||
map.entry(short).or_default().push((
|
||||
myname,
|
||||
Some(item.doc_value().map_or_else(String::new, |s| plain_text_summary(&s))),
|
||||
));
|
||||
map.entry(short).or_default().push(myname);
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -83,9 +83,6 @@ use crate::scrape_examples::{CallData, CallLocation};
|
||||
use crate::try_none;
|
||||
use crate::DOC_RUST_LANG_ORG_CHANNEL;
|
||||
|
||||
/// A pair of name and its optional document.
|
||||
pub(crate) type NameDoc = (String, Option<String>);
|
||||
|
||||
pub(crate) fn ensure_trailing_slash(v: &str) -> impl fmt::Display + '_ {
|
||||
crate::html::format::display_fn(move |f| {
|
||||
if !v.ends_with('/') && !v.is_empty() { write!(f, "{}/", v) } else { f.write_str(v) }
|
||||
|
@ -455,10 +455,7 @@ function loadCss(cssUrl) {
|
||||
const ul = document.createElement("ul");
|
||||
ul.className = "block " + shortty;
|
||||
|
||||
for (const item of filtered) {
|
||||
const name = item[0];
|
||||
const desc = item[1]; // can be null
|
||||
|
||||
for (const name of filtered) {
|
||||
let path;
|
||||
if (shortty === "mod") {
|
||||
path = name + "/index.html";
|
||||
@ -468,7 +465,6 @@ function loadCss(cssUrl) {
|
||||
const current_page = document.location.href.split("/").pop();
|
||||
const link = document.createElement("a");
|
||||
link.href = path;
|
||||
link.title = desc;
|
||||
if (path === current_page) {
|
||||
link.className = "current";
|
||||
}
|
||||
|
@ -1,27 +0,0 @@
|
||||
#![crate_type = "lib"]
|
||||
#![crate_name = "summaries"]
|
||||
|
||||
//! This *summary* has a [link] and `code`.
|
||||
//!
|
||||
//! This is the second paragraph.
|
||||
//!
|
||||
//! [link]: https://example.com
|
||||
|
||||
// @hasraw search-index.js 'This <em>summary</em> has a link and <code>code</code>.'
|
||||
// @!hasraw - 'second paragraph'
|
||||
|
||||
/// This `code` will be rendered in a code tag.
|
||||
///
|
||||
/// This text should not be rendered.
|
||||
pub struct Sidebar;
|
||||
|
||||
// @hasraw search-index.js 'This <code>code</code> will be rendered in a code tag.'
|
||||
// @hasraw summaries/sidebar-items.js 'This `code` will be rendered in a code tag.'
|
||||
// @!hasraw - 'text should not be rendered'
|
||||
|
||||
/// ```text
|
||||
/// this block should not be rendered
|
||||
/// ```
|
||||
pub struct Sidebar2;
|
||||
|
||||
// @!hasraw summaries/sidebar-items.js 'block should not be rendered'
|
Loading…
Reference in New Issue
Block a user