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

Jump to bottom

rustdoc: Show the correct source filename in page titles, without .html #78094

Merged
merged 2 commits into from
Oct 21, 2020
Merged

rustdoc: Show the correct source filename in page titles, without .html #78094

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48060f1
rustdoc: Show the correct source filename, without `.html`
camelid Oct 19, 2020
243c8e9
Apply some review suggestions
camelid Oct 20, 2020
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
17 changes: 8 additions & 9 deletions src/librustdoc/html/sources.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::html::layout;
use crate::html::render::{SharedContext, BASIC_KEYWORDS};
use rustc_hir::def_id::LOCAL_CRATE;
use rustc_span::source_map::FileName;
use std::ffi::OsStr;
use std::ffi::{OsStr, OsString};
use std::fs;
use std::path::{Component, Path, PathBuf};

Expand Down Expand Up @@ -84,7 +84,7 @@ impl<'a> SourceCollector<'a> {
};

// Remove the utf-8 BOM if any
if contents.starts_with("\u{feff}") {
if contents.starts_with('\u{feff}') {
contents.drain(..3);
}

Expand All @@ -99,16 +99,15 @@ impl<'a> SourceCollector<'a> {
href.push('/');
});
self.scx.ensure_dir(&cur)?;
let mut fname = p.file_name().expect("source has no filename").to_os_string();
fname.push(".html");

let src_fname =
String::from(p.file_name().expect("source has no filename").to_string_lossy());
camelid marked this conversation as resolved.
Show resolved Hide resolved
let fname = OsString::from(src_fname.clone() + ".html");
camelid marked this conversation as resolved.
Show resolved Hide resolved
cur.push(&fname);
href.push_str(&fname.to_string_lossy());

let title = format!(
"{} -- source",
cur.file_name().expect("failed to get file name").to_string_lossy()
);
let desc = format!("Source to the Rust file `{}`.", filename);
let title = format!("{} – source", src_fname,);
Copy link
Member Author

Choose a reason for hiding this comment

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

It might be better to just use a plain dash (-) rather than a Unicode en dash (–) since I think that's what other page titles use.

Copy link
Member

Choose a reason for hiding this comment

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

I would prefer to use - for now so it's consistent; if you want to use – then let's make a separate PR making all of the pages use – at once.

let desc = format!("Source of the Rust file `{}`.", filename);
let page = layout::Page {
title: &title,
css_class: "source",
Expand Down