reformat the docs for hidden code in rust sections #29309
Merged
Conversation
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
As displayed before this commit, I found the book confusing in its explanation of `#`-led comments in `rust` blocks. Possibly the biggest confusion was because the many-dashes construct does not become an HR element in the Markdown translator used, so things were not being properly set off. This change should more clearly show the as-rendered content as rendered, and the as-coded content as code.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @nikomatsakis (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. 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. |
|
@bors: rollup |
|
Yeah, thanks! This was a bit tough before, this way is much better. |
bors
added a commit
that referenced
this pull request
Oct 27, 2015
As displayed before this commit, I found the book confusing in its explanation of `#`-led comments in `rust` blocks. Possibly the biggest confusion was because the many-dashes construct does not become an HR element in the Markdown translator used, so things were not being properly set off. This change should more clearly show the as-rendered content as rendered, and the as-coded content as code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As displayed before this commit, I found the book confusing in its
explanation of
#-led comments inrustblocks. Possibly thebiggest confusion was because the many-dashes construct does not
become an HR element in the Markdown translator used, so things were
not being properly set off.
This change should more clearly show the as-rendered content as
rendered, and the as-coded content as code.