Skip to content

rustdoc: Some more lazy formatting #157796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rust-bors merged 1 commit into from
Jun 12, 2026
+32 −34
Merged

rustdoc: Some more lazy formatting #157796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/librustdoc/html/render/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2955,7 +2955,7 @@ fn render_call_locations<W: fmt::Write>(
fn render_attributes_in_code(
w: &mut impl fmt::Write,
item: &clean::Item,
prefix: &str,
prefix: impl fmt::Display,
cx: &Context<'_>,
) -> fmt::Result {
render_attributes_in_code_with_options(w, item, prefix, cx, true, "")
Expand All @@ -2964,14 +2964,14 @@ fn render_attributes_in_code(
pub(super) fn render_attributes_in_code_with_options(
w: &mut impl fmt::Write,
item: &clean::Item,
prefix: &str,
prefix: impl fmt::Display,
cx: &Context<'_>,
render_doc_hidden: bool,
open_tag: &str,
) -> fmt::Result {
w.write_str(open_tag)?;
if render_doc_hidden && item.is_doc_hidden() {
render_code_attribute(prefix, "#[doc(hidden)]", w)?;
render_code_attribute(&prefix, "#[doc(hidden)]", w)?;
}
for attr in &item.attrs.other_attrs {
let hir::Attribute::Parsed(kind) = attr else { continue };
Expand All @@ -2986,7 +2986,7 @@ pub(super) fn render_attributes_in_code_with_options(
AttributeKind::NonExhaustive(..) => Cow::Borrowed("#[non_exhaustive]"),
_ => continue,
};
render_code_attribute(prefix, attr.as_ref(), w)?;
render_code_attribute(&prefix, attr.as_ref(), w)?;
}

if let Some(def_id) = item.def_id()
Expand All @@ -3008,7 +3008,11 @@ fn render_repr_attribute_in_code(
Ok(())
}

fn render_code_attribute(prefix: &str, attr: &str, w: &mut impl fmt::Write) -> fmt::Result {
fn render_code_attribute(
prefix: impl fmt::Display,
attr: impl fmt::Display,
w: &mut impl fmt::Write,
) -> fmt::Result {
write!(w, "<div class=\"code-attribute\">{prefix}{attr}</div>")
}

Expand Down
50 changes: 22 additions & 28 deletions src/librustdoc/html/render/print_item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use std::borrow::Cow;
use std::cmp::Ordering;
use std::fmt::{self, Display, Write as _};
use std::iter;
Expand Down Expand Up @@ -395,25 +396,26 @@ fn item_module(cx: &Context<'_>, item: &clean::Item, items: &[clean::Item]) -> i
let (stab_tags, deprecation) = match import.source.did {
Some(import_def_id) => {
let stab_tags =
print_extra_info_tags(tcx, myitem, item, Some(import_def_id))
.to_string();
print_extra_info_tags(tcx, myitem, item, Some(import_def_id));
let deprecation = tcx
.lookup_deprecation(import_def_id)
.is_some_and(|deprecation| deprecation.is_in_effect());
(stab_tags, deprecation)
(Some(stab_tags), deprecation)
}
None => (String::new(), item.is_deprecated(tcx)),
None => (None, item.is_deprecated(tcx)),
};
let visibility_and_hidden = visibility_and_hidden(myitem);
let id = match import.kind {
clean::ImportKind::Simple(s) => {
format!(" id=\"{}\"", cx.derive_id(format!("reexport.{s}")))
}
clean::ImportKind::Glob => String::new(),
clean::ImportKind::Simple(s) => Some(format_args!(
" id=\"{}\"",
cx.derive_id(format!("reexport.{s}"))
)),
clean::ImportKind::Glob => None,
};
write!(
w,
"<dt{id}{deprecation_attr}><code>",
id = id.maybe_display(),
deprecation_attr = deprecation_class_attr(deprecation)
)?;
write!(
Expand All @@ -423,6 +425,7 @@ fn item_module(cx: &Context<'_>, item: &clean::Item, items: &[clean::Item]) -> i
vis = visibility_print_with_space(myitem, cx),
imp = print_import(import, cx),
visibility_and_hidden = visibility_and_hidden,
stab_tags = stab_tags.maybe_display(),
)?;
}
_ => {
Expand Down Expand Up @@ -512,18 +515,14 @@ fn print_extra_info_tags(
write!(f, "{}", tag_html("unstable", "", "Experimental"))?;
}

debug!(name = ?item.name, cfg = ?item.cfg, parent_cfg = ?parent.cfg, "Portability");

let cfg = match (&item.cfg, parent.cfg.as_ref()) {
(Some(cfg), Some(parent_cfg)) => cfg.simplify_with(parent_cfg),
(cfg, _) => cfg.as_deref().cloned(),
(Some(cfg), Some(parent_cfg)) => cfg.simplify_with(parent_cfg).map(Cow::Owned),
(cfg, _) => cfg.as_deref().map(Cow::Borrowed),
};

debug!(
"Portability name={name:?} {cfg:?} - {parent_cfg:?} = {cfg:?}",
name = item.name,
cfg = item.cfg,
parent_cfg = parent.cfg
);
if let Some(ref cfg) = cfg {
if let Some(cfg) = cfg {
write!(
f,
"{}",
Expand Down Expand Up @@ -976,7 +975,7 @@ fn item_trait(cx: &Context<'_>, it: &clean::Item, t: &clean::Trait) -> impl fmt:
"Dyn Compatibility",
"dyn-compatibility",
None,
format!(
format_args!(
"<div class=\"dyn-compatibility-info\"><p>This trait {} \
<a href=\"{base}/reference/items/traits.html#dyn-compatibility\">dyn compatible</a>.</p>\
<p><i>In older versions of Rust, dyn compatibility was called \"object safety\".</i></p></div>",
Expand Down Expand Up @@ -1775,10 +1774,10 @@ fn item_variants(
w,
"{}",
write_section_heading(
&format!("Variants{}", document_non_exhaustive_header(it)),
format_args!("Variants{}", document_non_exhaustive_header(it)),
"variants",
Some("variants"),
format!("{}<div class=\"variants\">", document_non_exhaustive(it)),
format_args!("{}<div class=\"variants\">", document_non_exhaustive(it)),
),
)?;

Expand Down Expand Up @@ -2105,20 +2104,15 @@ fn item_fields(
if let None | Some(CtorKind::Fn) = ctor_kind
&& fields.peek().is_some()
{
let title = format!(
let title = format_args!(
"{}{}",
if ctor_kind.is_none() { "Fields" } else { "Tuple Fields" },
document_non_exhaustive_header(it),
);
write!(
w,
"{}",
write_section_heading(
&title,
"fields",
Some("fields"),
document_non_exhaustive(it)
)
write_section_heading(title, "fields", Some("fields"), document_non_exhaustive(it))
)?;
for (index, (field, ty)) in fields.enumerate() {
let field_name =
Expand Down Expand Up @@ -2554,7 +2548,7 @@ fn render_struct_fields(
}
for field in fields {
if let clean::StructFieldItem(ref ty) = field.kind {
render_attributes_in_code(w, field, &format!("{tab} "), cx)?;
render_attributes_in_code(w, field, format_args!("{tab} "), cx)?;
writeln!(
w,
"{tab} {vis}{name}: {ty},",
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/html/render/write_shared.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ impl CratesIndexPart {
let layout = &cx.shared.layout;
let style_files = &cx.shared.style_files;
const DELIMITER: &str = "\u{FFFC}"; // users are being naughty if they have this
let content = format!(
let content = format_args!(
"<div class=\"main-heading\">\
<h1>List of all crates</h1>\
<rustdoc-toolbar></rustdoc-toolbar>\
Expand Down
Loading