Auto merge of #125599 - camelid:clarify-stability, r=notriddle,GuillaumeGomez
rustdoc: Clarify const-stability with regard to normal stability Fixes #125511. - Elide const-unstable if also unstable overall - Show "const" for const-unstable if also overall unstable
This commit is contained in:
commit
f00b02e6bb
@ -627,7 +627,7 @@ fn build_fn_header(
|
||||
) -> hir::FnHeader {
|
||||
let sig = tcx.fn_sig(def_id).skip_binder();
|
||||
let constness =
|
||||
if tcx.is_const_fn(def_id) && is_unstable_const_fn(tcx, def_id).is_none() {
|
||||
if tcx.is_const_fn(def_id) || is_unstable_const_fn(tcx, def_id).is_some() {
|
||||
hir::Constness::Const
|
||||
} else {
|
||||
hir::Constness::NotConst
|
||||
@ -649,9 +649,8 @@ fn build_fn_header(
|
||||
hir::Safety::Unsafe
|
||||
},
|
||||
abi,
|
||||
constness: if abi == Abi::RustIntrinsic
|
||||
&& tcx.is_const_fn(def_id)
|
||||
&& is_unstable_const_fn(tcx, def_id).is_none()
|
||||
constness: if tcx.is_const_fn(def_id)
|
||||
|| is_unstable_const_fn(tcx, def_id).is_some()
|
||||
{
|
||||
hir::Constness::Const
|
||||
} else {
|
||||
|
@ -13,7 +13,7 @@
|
||||
use std::iter::{self, once};
|
||||
|
||||
use rustc_ast as ast;
|
||||
use rustc_attr::{ConstStability, StabilityLevel};
|
||||
use rustc_attr::{ConstStability, StabilityLevel, StableSince};
|
||||
use rustc_data_structures::captures::Captures;
|
||||
use rustc_data_structures::fx::FxHashSet;
|
||||
use rustc_hir as hir;
|
||||
@ -1633,17 +1633,24 @@ fn print_with_space(&self) -> &str {
|
||||
|
||||
pub(crate) fn print_constness_with_space(
|
||||
c: &hir::Constness,
|
||||
s: Option<ConstStability>,
|
||||
overall_stab: Option<StableSince>,
|
||||
const_stab: Option<ConstStability>,
|
||||
) -> &'static str {
|
||||
match (c, s) {
|
||||
// const stable or when feature(staged_api) is not set
|
||||
(
|
||||
hir::Constness::Const,
|
||||
Some(ConstStability { level: StabilityLevel::Stable { .. }, .. }),
|
||||
)
|
||||
| (hir::Constness::Const, None) => "const ",
|
||||
// const unstable or not const
|
||||
_ => "",
|
||||
match c {
|
||||
hir::Constness::Const => match (overall_stab, const_stab) {
|
||||
// const stable...
|
||||
(_, Some(ConstStability { level: StabilityLevel::Stable { .. }, .. }))
|
||||
// ...or when feature(staged_api) is not set...
|
||||
| (_, None)
|
||||
// ...or when const unstable, but overall unstable too
|
||||
| (None, Some(ConstStability { level: StabilityLevel::Unstable { .. }, .. })) => {
|
||||
"const "
|
||||
}
|
||||
// const unstable (and overall stable)
|
||||
(Some(_), Some(ConstStability { level: StabilityLevel::Unstable { .. }, .. })) => "",
|
||||
},
|
||||
// not const
|
||||
hir::Constness::NotConst => "",
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -928,9 +928,11 @@ fn assoc_method(
|
||||
// FIXME: Once https://github.com/rust-lang/rust/issues/67792 is implemented, we can remove
|
||||
// this condition.
|
||||
let constness = match render_mode {
|
||||
RenderMode::Normal => {
|
||||
print_constness_with_space(&header.constness, meth.const_stability(tcx))
|
||||
}
|
||||
RenderMode::Normal => print_constness_with_space(
|
||||
&header.constness,
|
||||
meth.stable_since(tcx),
|
||||
meth.const_stability(tcx),
|
||||
),
|
||||
RenderMode::ForDeref { .. } => "",
|
||||
};
|
||||
let asyncness = header.asyncness.print_with_space();
|
||||
@ -1016,18 +1018,23 @@ fn render_stability_since_raw_with_extra(
|
||||
.map(|since| (format!("const since {since}"), format!("const: {since}")))
|
||||
}
|
||||
Some(ConstStability { level: StabilityLevel::Unstable { issue, .. }, feature, .. }) => {
|
||||
let unstable = if let Some(n) = issue {
|
||||
format!(
|
||||
"<a \
|
||||
if stable_version.is_none() {
|
||||
// don't display const unstable if entirely unstable
|
||||
None
|
||||
} else {
|
||||
let unstable = if let Some(n) = issue {
|
||||
format!(
|
||||
"<a \
|
||||
href=\"https://github.com/rust-lang/rust/issues/{n}\" \
|
||||
title=\"Tracking issue for {feature}\"\
|
||||
>unstable</a>"
|
||||
)
|
||||
} else {
|
||||
String::from("unstable")
|
||||
};
|
||||
)
|
||||
} else {
|
||||
String::from("unstable")
|
||||
};
|
||||
|
||||
Some((String::from("const unstable"), format!("const: {unstable}")))
|
||||
Some((String::from("const unstable"), format!("const: {unstable}")))
|
||||
}
|
||||
}
|
||||
_ => None,
|
||||
};
|
||||
|
@ -615,7 +615,18 @@ fn tag_html<'a>(
|
||||
fn item_function(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, f: &clean::Function) {
|
||||
let tcx = cx.tcx();
|
||||
let header = it.fn_header(tcx).expect("printing a function which isn't a function");
|
||||
let constness = print_constness_with_space(&header.constness, it.const_stability(tcx));
|
||||
debug!(
|
||||
"item_function/const: {:?} {:?} {:?} {:?}",
|
||||
it.name,
|
||||
&header.constness,
|
||||
it.stable_since(tcx),
|
||||
it.const_stability(tcx),
|
||||
);
|
||||
let constness = print_constness_with_space(
|
||||
&header.constness,
|
||||
it.stable_since(tcx),
|
||||
it.const_stability(tcx),
|
||||
);
|
||||
let safety = header.safety.print_with_space();
|
||||
let abi = print_abi_with_space(header.abi).to_string();
|
||||
let asyncness = header.asyncness.print_with_space();
|
||||
|
@ -24,6 +24,12 @@ pub const fn foo() -> u32 { 42 }
|
||||
#[unstable(feature = "humans", issue = "none")]
|
||||
pub const fn foo2() -> u32 { 42 }
|
||||
|
||||
// @has 'foo/fn.foo3.html' '//pre' 'pub const fn foo3() -> u32'
|
||||
// @!hasraw - '//span[@class="since"]'
|
||||
#[unstable(feature = "humans", issue = "none")]
|
||||
#[rustc_const_unstable(feature = "humans", issue = "none")]
|
||||
pub const fn foo3() -> u32 { 42 }
|
||||
|
||||
// @has 'foo/fn.bar2.html' '//pre' 'pub const fn bar2() -> u32'
|
||||
// @has - //span '1.0.0 (const: 1.0.0)'
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
|
Loading…
Reference in New Issue
Block a user