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.

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

Use the first paragraph, instead of cookie-cutter text, for rustdoc descriptions #82351

Merged
merged 8 commits into from
Feb 22, 2021
19 changes: 19 additions & 0 deletions src/test/rustdoc/description.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#![crate_name = "foo"]
//! # Description test crate
//!
//! This is the contents of the test crate docstring. It should not show up in the description.

// @matches 'foo/index.html' '//meta[@name="description"]/@content' 'Description test crate'
notriddle marked this conversation as resolved.
Show resolved Hide resolved

// @matches 'foo/foo_mod/index.html' '//meta[@name="description"]/@content' 'First paragraph description.'
/// First paragraph description.
///
/// Second paragraph should not show up.
pub mod foo_mod {
pub struct __Thing {}
}

// @matches 'foo/fn.foo_fn.html' '//meta[@name="description"]/@content' 'Only paragraph.'
/// Only paragraph.
pub fn foo_fn() {}

12 changes: 12 additions & 0 deletions src/test/rustdoc/description_default.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#![crate_name = "foo"]

// @matches 'foo/index.html' '//meta[@name="description"]/@content' 'API documentation for the Rust `foo` crate.'

// @matches 'foo/foo_mod/index.html' '//meta[@name="description"]/@content' 'API documentation for the Rust `foo_mod` mod in crate `foo`.'
pub mod foo_mod {
pub struct __Thing {}
}

// @matches 'foo/fn.foo_fn.html' '//meta[@name="description"]/@content' 'API documentation for the Rust `foo_fn` fn in crate `foo`.'
pub fn foo_fn() {}