bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rename "stability" CSS class to "item-info"

Browse source
This commit is contained in:
Guillaume Gomez 2020-11-23 13:20:16 +01:00
parent 53d19b37c5
commit caf6c5790a
8 changed files with 59 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

51
src/librustdoc/html/render/mod.rs
View file

@ -1844,7 +1844,7 @@ fn document(w: &mut Buffer, cx: &Context, item: &clean::Item, parent: Option<&cl
if let Some(ref name) = item.name { if let Some(ref name) = item.name {
info!("Documenting {}", name); info!("Documenting {}", name);
} }
document_stability(w, cx, item, false, parent); document_item_info(w, cx, item, false, parent);
document_full(w, item, cx, "", false); document_full(w, item, cx, "", false);
} }
@ -1928,18 +1928,23 @@ fn document_full(w: &mut Buffer, item: &clean::Item, cx: &Context, prefix: &str,
} }
} }
fn document_stability( /// Add extra information about an item such as:
///
/// * Stability
/// * Deprecated
/// * Required features (through the `doc_cfg` feature)
fn document_item_info(
w: &mut Buffer, w: &mut Buffer,
cx: &Context, cx: &Context,
item: &clean::Item, item: &clean::Item,
is_hidden: bool, is_hidden: bool,
parent: Option<&clean::Item>, parent: Option<&clean::Item>,
) { ) {
let stabilities = short_stability(item, cx, parent); let item_infos = short_item_info(item, cx, parent);
if !stabilities.is_empty() { if !item_infos.is_empty() {
write!(w, "<div class=\"stability{}\">", if is_hidden { " hidden" } else { "" }); write!(w, "<div class=\"item-info{}\">", if is_hidden { " hidden" } else { "" });
for stability in stabilities { for info in item_infos {
write!(w, "{}", stability); write!(w, "{}", info);
} }
write!(w, "</div>"); write!(w, "</div>");
} }
@ -2194,7 +2199,7 @@ fn item_module(w: &mut Buffer, cx: &Context, item: &clean::Item, items: &[clean:
<td class=\"docblock-short\">{stab_tags}{docs}</td>\ <td class=\"docblock-short\">{stab_tags}{docs}</td>\
</tr>", </tr>",
name = *myitem.name.as_ref().unwrap(), name = *myitem.name.as_ref().unwrap(),
stab_tags = stability_tags(myitem, item), stab_tags = extra_info_tags(myitem, item),
docs = MarkdownSummaryLine(doc_value, &myitem.links()).into_string(), docs = MarkdownSummaryLine(doc_value, &myitem.links()).into_string(),
class = myitem.type_(), class = myitem.type_(),
add = add, add = add,
@ -2216,9 +2221,9 @@ fn item_module(w: &mut Buffer, cx: &Context, item: &clean::Item, items: &[clean:
} }
} }
/// Render the stability and deprecation tags that are displayed in the item's summary at the /// Render the stability, deprecation and portability tags that are displayed in the item's summary
/// module level. /// at the module level.
fn stability_tags(item: &clean::Item, parent: &clean::Item) -> String { fn extra_info_tags(item: &clean::Item, parent: &clean::Item) -> String {
let mut tags = String::new(); let mut tags = String::new();
fn tag_html(class: &str, title: &str, contents: &str) -> String { fn tag_html(class: &str, title: &str, contents: &str) -> String {
@ -2271,10 +2276,10 @@ fn portability(item: &clean::Item, parent: Option<&clean::Item>) -> Option<Strin
Some(format!("<div class=\"stab portability\">{}</div>", cfg?.render_long_html())) Some(format!("<div class=\"stab portability\">{}</div>", cfg?.render_long_html()))
} }
/// Render the stability and/or deprecation warning that is displayed at the top of the item's /// Render the stability, deprecation and portability information that is displayed at the top of
/// documentation. /// the item's documentation.
fn short_stability(item: &clean::Item, cx: &Context, parent: Option<&clean::Item>) -> Vec<String> { fn short_item_info(item: &clean::Item, cx: &Context, parent: Option<&clean::Item>) -> Vec<String> {
let mut stability = vec![]; let mut extra_info = vec![];
let error_codes = cx.shared.codes; let error_codes = cx.shared.codes;
if let Some(Deprecation { ref note, ref since, is_since_rustc_version }) = item.deprecation { if let Some(Deprecation { ref note, ref since, is_since_rustc_version }) = item.deprecation {
@ -2301,7 +2306,7 @@ fn short_stability(item: &clean::Item, cx: &Context, parent: Option<&clean::Item
); );
message.push_str(&format!(": {}", html.into_string())); message.push_str(&format!(": {}", html.into_string()));
} }
stability.push(format!( extra_info.push(format!(
"<div class=\"stab deprecated\"><span class=\"emoji\">👎</span> {}</div>", "<div class=\"stab deprecated\"><span class=\"emoji\">👎</span> {}</div>",
message, message,
)); ));
@ -2345,14 +2350,14 @@ fn short_stability(item: &clean::Item, cx: &Context, parent: Option<&clean::Item
); );
} }
stability.push(format!("<div class=\"stab unstable\">{}</div>", message)); extra_info.push(format!("<div class=\"stab unstable\">{}</div>", message));
} }
if let Some(portability) = portability(item, parent) { if let Some(portability) = portability(item, parent) {
stability.push(portability); extra_info.push(portability);
} }
stability extra_info
} }
fn item_constant(w: &mut Buffer, cx: &Context, it: &clean::Item, c: &clean::Constant) { fn item_constant(w: &mut Buffer, cx: &Context, it: &clean::Item, c: &clean::Constant) {
@ -3703,7 +3708,7 @@ fn render_impl(
if trait_.is_some() { if trait_.is_some() {
if let Some(portability) = portability(&i.impl_item, Some(parent)) { if let Some(portability) = portability(&i.impl_item, Some(parent)) {
write!(w, "<div class=\"stability\">{}</div>", portability); write!(w, "<div class=\"item-info\">{}</div>", portability);
} }
} }
@ -3801,7 +3806,7 @@ fn render_impl(
if let Some(it) = t.items.iter().find(|i| i.name == item.name) { if let Some(it) = t.items.iter().find(|i| i.name == item.name) {
// We need the stability of the item from the trait // We need the stability of the item from the trait
// because impls can't have a stability. // because impls can't have a stability.
document_stability(w, cx, it, is_hidden, Some(parent)); document_item_info(w, cx, it, is_hidden, Some(parent));
if item.doc_value().is_some() { if item.doc_value().is_some() {
document_full(w, item, cx, "", is_hidden); document_full(w, item, cx, "", is_hidden);
} else if show_def_docs { } else if show_def_docs {
@ -3811,13 +3816,13 @@ fn render_impl(
} }
} }
} else { } else {
document_stability(w, cx, item, is_hidden, Some(parent)); document_item_info(w, cx, item, is_hidden, Some(parent));
if show_def_docs { if show_def_docs {
document_full(w, item, cx, "", is_hidden); document_full(w, item, cx, "", is_hidden);
} }
} }
} else { } else {
document_stability(w, cx, item, is_hidden, Some(parent)); document_item_info(w, cx, item, is_hidden, Some(parent));
if show_def_docs { if show_def_docs {
document_short(w, item, link, "", is_hidden); document_short(w, item, link, "", is_hidden);
} }

17
src/librustdoc/html/static/main.js
View file

@ -2266,7 +2266,7 @@ function defocusSearchBar() {
} }
} }
var ns = n.nextElementSibling; var ns = n.nextElementSibling;
while (ns && (hasClass(ns, "docblock") || hasClass(ns, "stability"))) { while (ns && (hasClass(ns, "docblock") || hasClass(ns, "item-info"))) {
if (addOrRemove) { if (addOrRemove) {
addClass(ns, "hidden-by-impl-hider"); addClass(ns, "hidden-by-impl-hider");
} else { } else {
@ -2282,7 +2282,7 @@ function defocusSearchBar() {
var action = mode; var action = mode;
if (hasClass(toggle.parentNode, "impl") === false) { if (hasClass(toggle.parentNode, "impl") === false) {
relatedDoc = toggle.parentNode.nextElementSibling; relatedDoc = toggle.parentNode.nextElementSibling;
if (hasClass(relatedDoc, "stability")) { if (hasClass(relatedDoc, "item-info")) {
relatedDoc = relatedDoc.nextElementSibling; relatedDoc = relatedDoc.nextElementSibling;
} }
if (hasClass(relatedDoc, "docblock") || hasClass(relatedDoc, "sub-variant")) { if (hasClass(relatedDoc, "docblock") || hasClass(relatedDoc, "sub-variant")) {
@ -2332,16 +2332,17 @@ function defocusSearchBar() {
var dontApplyBlockRule = toggle.parentNode.parentNode.id !== "main"; var dontApplyBlockRule = toggle.parentNode.parentNode.id !== "main";
if (action === "show") { if (action === "show") {
removeClass(relatedDoc, "fns-now-collapsed"); removeClass(relatedDoc, "fns-now-collapsed");
// Stability information is never hidden. // Stability/deprecation/portability information is never hidden.
if (hasClass(docblock, "stability") === false) { if (hasClass(docblock, "item-info") === false) {
removeClass(docblock, "hidden-by-usual-hider"); removeClass(docblock, "hidden-by-usual-hider");
} }
onEachLazy(toggle.childNodes, adjustToggle(false, dontApplyBlockRule)); onEachLazy(toggle.childNodes, adjustToggle(false, dontApplyBlockRule));
onEachLazy(relatedDoc.childNodes, implHider(false, dontApplyBlockRule)); onEachLazy(relatedDoc.childNodes, implHider(false, dontApplyBlockRule));
} else if (action === "hide") { } else if (action === "hide") {
addClass(relatedDoc, "fns-now-collapsed"); addClass(relatedDoc, "fns-now-collapsed");
// Stability information should be shown even when detailed info is hidden. // Stability/deprecation/portability information should be shown even when detailed
if (hasClass(docblock, "stability") === false) { // info is hidden.
if (hasClass(docblock, "item-info") === false) {
addClass(docblock, "hidden-by-usual-hider"); addClass(docblock, "hidden-by-usual-hider");
} }
onEachLazy(toggle.childNodes, adjustToggle(true, dontApplyBlockRule)); onEachLazy(toggle.childNodes, adjustToggle(true, dontApplyBlockRule));
@ -2445,7 +2446,7 @@ function defocusSearchBar() {
var func = function(e) { var func = function(e) {
var next = e.nextElementSibling; var next = e.nextElementSibling;
if (next && hasClass(next, "stability")) { if (next && hasClass(next, "item-info")) {
next = next.nextElementSibling; next = next.nextElementSibling;
} }
if (!next) { if (!next) {
@ -2462,7 +2463,7 @@ function defocusSearchBar() {
var funcImpl = function(e) { var funcImpl = function(e) {
var next = e.nextElementSibling; var next = e.nextElementSibling;
if (next && hasClass(next, "stability")) { if (next && hasClass(next, "item-info")) {
next = next.nextElementSibling; next = next.nextElementSibling;
} }
if (next && hasClass(next, "docblock")) { if (next && hasClass(next, "docblock")) {

18
src/librustdoc/html/static/rustdoc.css
View file

@ -553,21 +553,21 @@ h4 > code, h3 > code, .invisible > code {
border: none; border: none;
} }
.content .stability code { .content .item-info code {
font-size: 90%; font-size: 90%;
} }
.content .stability { .content .item-info {
position: relative; position: relative;
margin-left: 33px; margin-left: 33px;
margin-top: -13px; margin-top: -13px;
} }
.sub-variant > div > .stability { .sub-variant > div > .item-info {
margin-top: initial; margin-top: initial;
} }
.content .stability::before { .content .item-info::before {
content: '⬑'; content: '⬑';
font-size: 25px; font-size: 25px;
position: absolute; position: absolute;
@ -579,15 +579,15 @@ h4 > code, h3 > code, .invisible > code {
margin-left: 20px; margin-left: 20px;
} }
.content .impl-items .docblock, .content .impl-items .stability { .content .impl-items .docblock, .content .impl-items .item-info {
margin-bottom: .6em; margin-bottom: .6em;
} }
.content .impl-items > .stability { .content .impl-items > .item-info {
margin-left: 40px; margin-left: 40px;
} }
.methods > .stability, .content .impl-items > .stability { .methods > .item-info, .content .impl-items > .item-info {
margin-top: -8px; margin-top: -8px;
} }
@ -595,7 +595,7 @@ h4 > code, h3 > code, .invisible > code {
flex-basis: 100%; flex-basis: 100%;
} }
#main > .stability { #main > .item-info {
margin-top: 0; margin-top: 0;
} }
@ -655,7 +655,7 @@ a {
} }
.docblock a:not(.srclink):not(.test-arrow):hover, .docblock a:not(.srclink):not(.test-arrow):hover,
.docblock-short a:not(.srclink):not(.test-arrow):hover, .stability a { .docblock-short a:not(.srclink):not(.test-arrow):hover, .item-info a {
text-decoration: underline; text-decoration: underline;
} }

4
src/librustdoc/html/static/themes/ayu.css
View file

@ -166,7 +166,7 @@ pre {
color: #c5c5c5; color: #c5c5c5;
} }
.content .stability::before { color: #ccc; } .content .item-info::before { color: #ccc; }
.content span.foreigntype, .content a.foreigntype { color: #ef57ff; } .content span.foreigntype, .content a.foreigntype { color: #ef57ff; }
.content span.union, .content a.union { color: #98a01c; } .content span.union, .content a.union { color: #98a01c; }
@ -219,7 +219,7 @@ a {
} }
.docblock:not(.type-decl) a:not(.srclink):not(.test-arrow), .docblock:not(.type-decl) a:not(.srclink):not(.test-arrow),
.docblock-short a:not(.srclink):not(.test-arrow), .stability a, .docblock-short a:not(.srclink):not(.test-arrow), .item-info a,
#help a { #help a {
color: #39AFD7; color: #39AFD7;
} }

4
src/librustdoc/html/static/themes/dark.css
View file

@ -136,7 +136,7 @@ pre {
.content .highlighted.primitive { background-color: #00708a; } .content .highlighted.primitive { background-color: #00708a; }
.content .highlighted.keyword { background-color: #884719; } .content .highlighted.keyword { background-color: #884719; }
.content .stability::before { color: #ccc; } .content .item-info::before { color: #ccc; }
.content span.enum, .content a.enum, .block a.current.enum { color: #82b089; } .content span.enum, .content a.enum, .block a.current.enum { color: #82b089; }
.content span.struct, .content a.struct, .block a.current.struct { color: #2dbfb8; } .content span.struct, .content a.struct, .block a.current.struct { color: #2dbfb8; }
@ -177,7 +177,7 @@ a {
} }
.docblock:not(.type-decl) a:not(.srclink):not(.test-arrow), .docblock:not(.type-decl) a:not(.srclink):not(.test-arrow),
.docblock-short a:not(.srclink):not(.test-arrow), .stability a, .docblock-short a:not(.srclink):not(.test-arrow), .item-info a,
#help a { #help a {
color: #D2991D; color: #D2991D;
} }

4
src/librustdoc/html/static/themes/light.css
View file

@ -134,7 +134,7 @@ pre {
.content .highlighted.primitive { background-color: #9aecff; } .content .highlighted.primitive { background-color: #9aecff; }
.content .highlighted.keyword { background-color: #f99650; } .content .highlighted.keyword { background-color: #f99650; }
.content .stability::before { color: #ccc; } .content .item-info::before { color: #ccc; }
.content span.enum, .content a.enum, .block a.current.enum { color: #508157; } .content span.enum, .content a.enum, .block a.current.enum { color: #508157; }
.content span.struct, .content a.struct, .block a.current.struct { color: #ad448e; } .content span.struct, .content a.struct, .block a.current.struct { color: #ad448e; }
@ -175,7 +175,7 @@ a {
} }
.docblock:not(.type-decl) a:not(.srclink):not(.test-arrow), .docblock:not(.type-decl) a:not(.srclink):not(.test-arrow),
.docblock-short a:not(.srclink):not(.test-arrow), .stability a, .docblock-short a:not(.srclink):not(.test-arrow), .item-info a,
#help a { #help a {
color: #3873AD; color: #3873AD;
} }

12
src/test/rustdoc/doc-cfg.rs
View file

@ -2,20 +2,20 @@
#![feature(target_feature, cfg_target_feature)] #![feature(target_feature, cfg_target_feature)]
// @has doc_cfg/struct.Portable.html // @has doc_cfg/struct.Portable.html
// @!has - '//*[@id="main"]/*[@class="stability"]/*[@class="stab portability"]' '' // @!has - '//*[@id="main"]/*[@class="item-info"]/*[@class="stab portability"]' ''
// @has - '//*[@id="method.unix_and_arm_only_function"]' 'fn unix_and_arm_only_function()' // @has - '//*[@id="method.unix_and_arm_only_function"]' 'fn unix_and_arm_only_function()'
// @has - '//*[@class="stab portability"]' 'This is supported on Unix and ARM only.' // @has - '//*[@class="stab portability"]' 'This is supported on Unix and ARM only.'
pub struct Portable; pub struct Portable;
// @has doc_cfg/unix_only/index.html \ // @has doc_cfg/unix_only/index.html \
// '//*[@id="main"]/*[@class="stability"]/*[@class="stab portability"]' \ // '//*[@id="main"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'This is supported on Unix only.' // 'This is supported on Unix only.'
// @matches - '//*[@class="module-item"]//*[@class="stab portability"]' '\AARM\Z' // @matches - '//*[@class="module-item"]//*[@class="stab portability"]' '\AARM\Z'
// @count - '//*[@class="stab portability"]' 2 // @count - '//*[@class="stab portability"]' 2
#[doc(cfg(unix))] #[doc(cfg(unix))]
pub mod unix_only { pub mod unix_only {
// @has doc_cfg/unix_only/fn.unix_only_function.html \ // @has doc_cfg/unix_only/fn.unix_only_function.html \
// '//*[@id="main"]/*[@class="stability"]/*[@class="stab portability"]' \ // '//*[@id="main"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'This is supported on Unix only.' // 'This is supported on Unix only.'
// @count - '//*[@class="stab portability"]' 1 // @count - '//*[@class="stab portability"]' 1
pub fn unix_only_function() { pub fn unix_only_function() {
@ -23,7 +23,7 @@ pub mod unix_only {
} }
// @has doc_cfg/unix_only/trait.ArmOnly.html \ // @has doc_cfg/unix_only/trait.ArmOnly.html \
// '//*[@id="main"]/*[@class="stability"]/*[@class="stab portability"]' \ // '//*[@id="main"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'This is supported on Unix and ARM only.' // 'This is supported on Unix and ARM only.'
// @count - '//*[@class="stab portability"]' 2 // @count - '//*[@class="stab portability"]' 2
#[doc(cfg(target_arch = "arm"))] #[doc(cfg(target_arch = "arm"))]
@ -44,7 +44,7 @@ pub mod unix_only {
// @matches - '//*[@class="module-item"]//*[@class="stab portability"]' '\Aavx\Z' // @matches - '//*[@class="module-item"]//*[@class="stab portability"]' '\Aavx\Z'
// @has doc_cfg/fn.uses_target_feature.html // @has doc_cfg/fn.uses_target_feature.html
// @has - '//*[@id="main"]/*[@class="stability"]/*[@class="stab portability"]' \ // @has - '//*[@id="main"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'This is supported with target feature avx only.' // 'This is supported with target feature avx only.'
#[target_feature(enable = "avx")] #[target_feature(enable = "avx")]
pub unsafe fn uses_target_feature() { pub unsafe fn uses_target_feature() {
@ -52,7 +52,7 @@ pub unsafe fn uses_target_feature() {
} }
// @has doc_cfg/fn.uses_cfg_target_feature.html // @has doc_cfg/fn.uses_cfg_target_feature.html
// @has - '//*[@id="main"]/*[@class="stability"]/*[@class="stab portability"]' \ // @has - '//*[@id="main"]/*[@class="item-info"]/*[@class="stab portability"]' \
// 'This is supported with target feature avx only.' // 'This is supported with target feature avx only.'
#[doc(cfg(target_feature = "avx"))] #[doc(cfg(target_feature = "avx"))]
pub fn uses_cfg_target_feature() { pub fn uses_cfg_target_feature() {

2
src/test/rustdoc/stability.rs
View file

@ -4,7 +4,7 @@
pub struct Unstable { pub struct Unstable {
// @has stability/struct.Unstable.html \ // @has stability/struct.Unstable.html \
// '//div[@class="stability"]//div[@class="stab unstable"]' \ // '//div[@class="item-info"]//div[@class="stab unstable"]' \
// 'This is a nightly-only experimental API' // 'This is a nightly-only experimental API'
// @count stability/struct.Unstable.html '//span[@class="stab unstable"]' 0 // @count stability/struct.Unstable.html '//span[@class="stab unstable"]' 0
pub foo: u32, pub foo: u32,