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

Fix rustdoc item summaries that are headers #46387

Merged
merged 1 commit into from
Dec 2, 2017
Merged

Conversation

chrisduerr
Copy link
Contributor

@chrisduerr 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

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
Copy link
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.

@QuietMisdreavus
Copy link
Member

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

@QuietMisdreavus
Copy link
Member

@bors r+

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

@bors
Copy link
Contributor

bors commented Nov 30, 2017

📌 Commit 91a4106 has been approved by QuietMisdreavus

@kennytm kennytm added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Nov 30, 2017
@chrisduerr
Copy link
Contributor Author

Thanks for walking me through this! :)

@kennytm kennytm changed the title Fix rustoc item summaries that are headers Fix rustdoc item summaries that are headers Nov 30, 2017
@QuietMisdreavus
Copy link
Member

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

@bors r+

@bors
Copy link
Contributor

bors commented Nov 30, 2017

📌 Commit 91a4106 has been approved by QuietMisdreavus

@frewsxcv
Copy link
Member

frewsxcv commented Dec 1, 2017

@bors rollup

kennytm added a commit to kennytm/rust that referenced this pull request Dec 1, 2017
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
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rustdoc: item summaries that are headers are not printed in module pages, under hoedown
7 participants