-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Use the first paragraph, instead of cookie-cutter text, for rustdoc descriptions #82351
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5538528
Use the first paragraph, instead of cookie-cutter text, for rustdoc d…
notriddle 1bedd4d
Cut off plain text descriptions after headers
notriddle bcef5e7
Revert changes to all.html
notriddle 8b3b1c9
Add rustdoc UI tests for new description behaviour
notriddle dcf4991
Fix formatting for description rustdoc UI tests
notriddle fd5a710
Use has for non-regexes
notriddle a6b85fb
Update src/test/rustdoc/description.rs
notriddle 575c75b
Update src/test/rustdoc/description.rs
notriddle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 contains hidden or 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 contains hidden or 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 contains hidden or 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,24 @@ | ||
#![crate_name = "foo"] | ||
//! # Description test crate | ||
//! | ||
//! This is the contents of the test crate docstring. | ||
//! It should not show up in the description. | ||
|
||
// @has 'foo/index.html' '//meta[@name="description"]/@content' \ | ||
// 'Description test crate' | ||
// @!has - '//meta[@name="description"]/@content' 'should not show up' | ||
|
||
// @has 'foo/foo_mod/index.html' '//meta[@name="description"]/@content' \ | ||
// 'First paragraph description.' | ||
notriddle marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// @!has - '//meta[@name="description"]/@content' 'Second paragraph' | ||
/// First paragraph description. | ||
/// | ||
/// Second paragraph should not show up. | ||
pub mod foo_mod { | ||
pub struct __Thing {} | ||
} | ||
|
||
// @has 'foo/fn.foo_fn.html' '//meta[@name="description"]/@content' \ | ||
// 'Only paragraph.' | ||
/// Only paragraph. | ||
pub fn foo_fn() {} |
This file contains hidden or 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,14 @@ | ||
#![crate_name = "foo"] | ||
|
||
// @has 'foo/index.html' '//meta[@name="description"]/@content' \ | ||
// 'API documentation for the Rust `foo` crate.' | ||
|
||
// @has '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 {} | ||
} | ||
|
||
// @has 'foo/fn.foo_fn.html' '//meta[@name="description"]/@content' \ | ||
// 'API documentation for the Rust `foo_fn` fn in crate `foo`.' | ||
pub fn foo_fn() {} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.