Skip to content

Fix error explanation formatting #38007

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 2 commits into from
Nov 27, 2016
Merged

Fix error explanation formatting #38007

merged 2 commits into from
Nov 27, 2016

Conversation

alygin
Copy link
Contributor

@alygin alygin commented Nov 25, 2016

Errors E0101, E0458, E0535 and E0537 have incorrectly formatted bulleted lists in their explanations. As the result, they are not rendered as lists in the documentation.

The fix applies the correct formatting to those lists.

@rust-highfive
Copy link
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @eddyb (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.

@eddyb
Copy link
Member

eddyb commented Nov 25, 2016

Odd, does nothing else use * lists? This seems very surprising to me.
r? @jonathandturner

@rust-highfive rust-highfive assigned sophiajt and unassigned eddyb Nov 25, 2016
@alygin
Copy link
Contributor Author

alygin commented Nov 26, 2016

It seems such lists are broken when they appear in .rs-files, those in .md-documents are rendered correctly. Searching through all the *.rs files only gave me those four cases from the error index.

@eddyb eddyb added I-nominated A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Nov 26, 2016
@ollie27
Copy link
Member

ollie27 commented Nov 26, 2016

I think the reason the lists aren't working is because of the lack of an empty line before the start of the list. Just adding those should be enough.

@alygin
Copy link
Contributor Author

alygin commented Nov 26, 2016

@ollie27, you're absolutely right. I've simplified the fix.

@eddyb
Copy link
Member

eddyb commented Nov 26, 2016

Ah there we go. @bors r+ rollup

@bors
Copy link
Collaborator

bors commented Nov 26, 2016

📌 Commit 984c039 has been approved by eddyb

@bors
Copy link
Collaborator

bors commented Nov 27, 2016

⌛ Testing commit 984c039 with merge 0e17ba5...

bors added a commit that referenced this pull request Nov 27, 2016
Fix error explanation formatting

Errors E0101, E0458, E0535 and E0537 have incorrectly formatted bulleted lists in their explanations. As the result, they are not rendered as lists in the documentation.

The fix applies the correct formatting to those lists.
@bors bors merged commit 984c039 into rust-lang:master Nov 27, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants