-
Notifications
You must be signed in to change notification settings - Fork 12.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rollup merge of #84380 - Smittyvb:rdoc-title-order, r=jsha
Write Rustdoc titles like "x in crate::mod - Rust" This makes Rustdoc titles for items be like "Widget in cratename::blah::foo - Rust". Titles for modules and other non-items are unchanged, and still read like "cratename::blah::foo - Rust". This makes managing several open Rustdoc tabs easier. ![A screenshot of several open Rustdoc tabs](https://user-images.githubusercontent.com/10530973/115457675-d608f180-a1f2-11eb-87a8-838a32b4e3f7.png) This also adds some tests for the new title behavior. Closes #84371.
- Loading branch information
Showing
3 changed files
with
56 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
#![crate_name = "foo"] | ||
#![feature(doc_keyword)] | ||
|
||
// tests for the html <title> element | ||
|
||
// @has foo/index.html '//head/title' 'foo - Rust' | ||
|
||
// @has foo/fn.widget_count.html '//head/title' 'widget_count in foo - Rust' | ||
/// blah | ||
pub fn widget_count() {} | ||
|
||
// @has foo/struct.Widget.html '//head/title' 'Widget in foo - Rust' | ||
pub struct Widget; | ||
|
||
// @has foo/constant.ANSWER.html '//head/title' 'ANSWER in foo - Rust' | ||
pub const ANSWER: u8 = 42; | ||
|
||
// @has foo/blah/index.html '//head/title' 'foo::blah - Rust' | ||
pub mod blah { | ||
// @has foo/blah/struct.Widget.html '//head/title' 'Widget in foo::blah - Rust' | ||
pub struct Widget; | ||
|
||
// @has foo/blah/trait.Awesome.html '//head/title' 'Awesome in foo::blah - Rust' | ||
pub trait Awesome {} | ||
|
||
// @has foo/blah/fn.make_widget.html '//head/title' 'make_widget in foo::blah - Rust' | ||
pub fn make_widget() {} | ||
|
||
// @has foo/macro.cool_macro.html '//head/title' 'cool_macro in foo - Rust' | ||
#[macro_export] | ||
macro_rules! cool_macro { | ||
($t:tt) => { $t } | ||
} | ||
} | ||
|
||
// @has foo/keyword.continue.html '//head/title' 'continue - Rust' | ||
#[doc(keyword = "continue")] | ||
mod continue_keyword {} | ||
|
||
// @has foo/primitive.u8.html '//head/title' 'u8 - Rust' | ||
// @!has - '//head/title' 'foo' | ||
#[doc(primitive = "u8")] | ||
/// `u8` docs | ||
mod u8 {} |