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

Used bold and italic in the markdown to make the stack and heap docum… #30404

Merged
merged 1 commit into from
Dec 18, 2015

Conversation

Shiney
Copy link
Contributor

@Shiney Shiney commented Dec 15, 2015

…entation clearer

I could not use colors as suggested for #29854 because Github doesn't support these in markdown, however this solution may be better for color-blind readers.

@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 @brson (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.

@huonw
Copy link
Member

huonw commented Dec 15, 2015

r? @steveklabnik

(I was thinking the colour could be done via <span style="color:..."></span> tags, which the documentation on the website rendered via rustdoc will display, although doing that is clearly much more annoying than bold and italic.)

@rust-highfive rust-highfive assigned steveklabnik and unassigned brson Dec 15, 2015
@steveklabnik
Copy link
Member

Ah interesting! I like this idea.

@Shiney , if it isn't too much work, would you mind:

  1. adding a sentence or two explicitly mentioning that the names are connected to the styling
  2. Squashing this down to one commit

Thank you!

And yes, we could do colors inline. Let's see how this works and maybe do that in the future, depending.

@Shiney
Copy link
Contributor Author

Shiney commented Dec 16, 2015

Okay, I think I've done all the git voodo required to squash the commits to one commit...

@steveklabnik
Copy link
Member

You have! Thanks so much.

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Dec 16, 2015

📌 Commit 62fa40f has been approved by steveklabnik

Manishearth added a commit to Manishearth/rust that referenced this pull request Dec 17, 2015
…abnik

…entation clearer

I could not use colors as suggested for rust-lang#29854 because Github doesn't support these in markdown, however this solution may be better for color-blind readers.
steveklabnik added a commit to steveklabnik/rust that referenced this pull request Dec 17, 2015
…abnik

…entation clearer

I could not use colors as suggested for rust-lang#29854 because Github doesn't support these in markdown, however this solution may be better for color-blind readers.
bors added a commit that referenced this pull request Dec 17, 2015
@bors bors merged commit 62fa40f into rust-lang:master Dec 18, 2015
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.

6 participants