Skip to content
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

rustdoc: Add missing dot separator #92937

Merged
merged 2 commits into from
Jan 17, 2022
Merged

rustdoc: Add missing dot separator #92937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29b659a
Fix missing dot separator
GuillaumeGomez Jan 15, 2022
75967ce
Add test for dot separator
GuillaumeGomez Jan 15, 2022
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
10 changes: 7 additions & 3 deletions src/librustdoc/html/render/print_item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,7 +670,11 @@ fn item_trait(w: &mut Buffer, cx: &Context<'_>, it: &clean::Item, t: &clean::Tra
}
write!(w, "<div id=\"{}\" class=\"method has-srclink\">", id);
write!(w, "<div class=\"rightside\">");
render_stability_since(w, m, t, cx.tcx());

let has_stability = render_stability_since(w, m, t, cx.tcx());
if has_stability {
w.write_str(" · ");
}
write_srclink(cx, m, w);
write!(w, "</div>");
write!(w, "<h4 class=\"code-header\">");
Expand Down Expand Up @@ -1457,14 +1461,14 @@ fn render_stability_since(
item: &clean::Item,
containing_item: &clean::Item,
tcx: TyCtxt<'_>,
) {
) -> bool {
render_stability_since_raw(
w,
item.stable_since(tcx),
item.const_stability(tcx),
containing_item.stable_since(tcx),
containing_item.const_stable_since(tcx),
);
)
}

fn compare_impl<'a, 'b>(lhs: &'a &&Impl, rhs: &'b &&Impl, cx: &Context<'_>) -> Ordering {
Expand Down
31 changes: 31 additions & 0 deletions src/test/rustdoc/source-version-separator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#![stable(feature = "bar", since = "1.0")]
#![crate_name = "foo"]

#![feature(staged_api)]

// @has foo/trait.Bar.html
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0· source · '
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a missing space here.

Suggested change
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0· source · '
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0· source · '

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jsha I think you forgot to add the space in your suggestion.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same answer as above.

#[stable(feature = "bar", since = "1.0")]
pub trait Bar {
// @has - '//div[@id="tymethod.foo"]/*[@class="rightside"]' '3.0 · source'
#[stable(feature = "foobar", since = "3.0")]
fn foo();
}

// @has - '//div[@id="implementors-list"]//*[@class="rightside"]' '4.0 · source'

// @has foo/struct.Foo.html
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0· source · '
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a missing space here.

Suggested change
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0· source · '
// @has - '//div[@class="main-heading"]/*[@class="out-of-band"]' '1.0 · source · '

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, there isn't (otherwise the test would fail). :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With an image you'll understand better what's happening:

Screenshot from 2022-01-16 17-46-31

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, got it. It looks like there's a missing-space problem in the templates, but it's papered over by padding. I'll fix in a followup PR.

#[stable(feature = "baz", since = "1.0")]
pub struct Foo;

impl Foo {
// @has - '//div[@id="method.foofoo"]/*[@class="rightside"]' '3.0 · source'
#[stable(feature = "foobar", since = "3.0")]
pub fn foofoo() {}
}

#[stable(feature = "yolo", since = "4.0")]
impl Bar for Foo {
fn foo() {}
}