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

Fix rustdoc item summaries that are headers #46387

Merged
merged 1 commit into from Dec 2, 2017

Conversation

Projects
None yet
7 participants
@chrisduerr
Contributor

chrisduerr commented Nov 29, 2017

Rustoc item summaries that are headers were not displayed at all because
they started with whitespace.

This PR fixes this and now removes the whitespace and then displays the
block.

I'm not sure if the rustdoc test is written correctly, if there's anything to improve, just let me know. :)

This fixes #46377.

This is how it looks when rendered out now:
Rendered

Fix rustoc item summaries that are headers
Rustoc item summaries that are headers were not displayed at all because
they started with whitespace.

This PR fixes this and now removes the whitespace and then displays the
block.
@rust-highfive

This comment has been minimized.

Show comment
Hide comment
@rust-highfive

rust-highfive Nov 29, 2017

Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

Collaborator

rust-highfive commented Nov 29, 2017

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@QuietMisdreavus

This comment has been minimized.

Show comment
Hide comment
@QuietMisdreavus

QuietMisdreavus Nov 29, 2017

Member

Thanks so much for writing this! r=me if Travis goes green.

Member

QuietMisdreavus commented Nov 29, 2017

Thanks so much for writing this! r=me if Travis goes green.

@QuietMisdreavus

This comment has been minimized.

Show comment
Hide comment
@QuietMisdreavus

QuietMisdreavus Nov 30, 2017

Member

@bors r+

All looks good to me! Travis checked out, so it looks like the test passes. Thanks again!

Member

QuietMisdreavus commented Nov 30, 2017

@bors r+

All looks good to me! Travis checked out, so it looks like the test passes. Thanks again!

@bors

This comment has been minimized.

Show comment
Hide comment
@bors

bors Nov 30, 2017

Contributor

📌 Commit 91a4106 has been approved by QuietMisdreavus

Contributor

bors commented Nov 30, 2017

📌 Commit 91a4106 has been approved by QuietMisdreavus

@chrisduerr

This comment has been minimized.

Show comment
Hide comment
@chrisduerr

chrisduerr Nov 30, 2017

Contributor

Thanks for walking me through this! :)

Contributor

chrisduerr commented Nov 30, 2017

Thanks for walking me through this! :)

@kennytm kennytm changed the title from Fix rustoc item summaries that are headers to Fix rustdoc item summaries that are headers Nov 30, 2017

@QuietMisdreavus

This comment has been minimized.

Show comment
Hide comment
@QuietMisdreavus

QuietMisdreavus Nov 30, 2017

Member

There was some mishaps with commits here, so let me make sure bors sees this PR correctly...

@bors r+

Member

QuietMisdreavus commented Nov 30, 2017

There was some mishaps with commits here, so let me make sure bors sees this PR correctly...

@bors r+

@bors

This comment has been minimized.

Show comment
Hide comment
@bors

bors Nov 30, 2017

Contributor

📌 Commit 91a4106 has been approved by QuietMisdreavus

Contributor

bors commented Nov 30, 2017

📌 Commit 91a4106 has been approved by QuietMisdreavus

@frewsxcv

This comment has been minimized.

Show comment
Hide comment
@frewsxcv

frewsxcv Dec 1, 2017

Member

@bors rollup

Member

frewsxcv commented Dec 1, 2017

@bors rollup

kennytm added a commit to kennytm/rust that referenced this pull request Dec 1, 2017

Rollup merge of rust-lang#46387 - chrisduerr:master, r=QuietMisdreavus
Fix rustdoc item summaries that are headers

Rustoc item summaries that are headers were not displayed at all because
they started with whitespace.

This PR fixes this and now removes the whitespace and then displays the
block.

I'm not sure if the rustdoc test is written correctly, if there's anything to improve, just let me know. :)

This fixes rust-lang#46377.

This is how it looks when rendered out now:
![Rendered](https://i.imgur.com/7u8jUAM.png)

bors added a commit that referenced this pull request Dec 1, 2017

Auto merge of #46430 - kennytm:rollup, r=kennytm
Rollup of 13 pull requests

- Successful merges: #45880, #46280, #46373, #46376, #46385, #46386, #46387, #46392, #46400, #46401, #46405, #46412, #46421
- Failed merges:

@bors bors merged commit 91a4106 into rust-lang:master Dec 2, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment