Skip to content

separate doc heading from body #3083

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 1 commit into from
Dec 10, 2020
Merged

separate doc heading from body #3083

merged 1 commit into from
Dec 10, 2020

Conversation

tshepang
Copy link
Member

@tshepang tshepang commented Dec 10, 2020

If you look at target/doc/cargo_registry/util/index.html, you will see this heading after errors:

This module implements several error types and traits. The suggested usage in returned results is as follows:

The first line is taken as a heading, so should remain separate, so that it's readable as a summary.

@rust-highfive
Copy link

r? @jtgeibel

(rust-highfive has picked a reviewer for you, use r? to override)

@Turbo87
Copy link
Member

Turbo87 commented Dec 10, 2020

@tshepang an you add a pull request description explaining what you're changing here and why you're changing it? 🙏

@tshepang
Copy link
Member Author

just did @Turbo87

@Turbo87
Copy link
Member

Turbo87 commented Dec 10, 2020

I see what you mean:

Bildschirmfoto 2020-12-10 um 11 12 41

makes sense, thanks!

@bors r+

@bors
Copy link
Contributor

bors commented Dec 10, 2020

📌 Commit 588da69 has been approved by Turbo87

@bors
Copy link
Contributor

bors commented Dec 10, 2020

⌛ Testing commit 588da69 with merge f7096cc...

@bors
Copy link
Contributor

bors commented Dec 10, 2020

☀️ Test successful - checks-actions
Approved by: Turbo87
Pushing f7096cc to master...

@bors bors merged commit f7096cc into rust-lang:master Dec 10, 2020
@tshepang tshepang deleted the patch-2 branch December 10, 2020 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants