Miscellaneous README changes #22662
Miscellaneous README changes #22662
Conversation
- Various grammatical changes. - Use triple-backtick syntax and sh highlighting for code blocks. - Fix indentation of code block in step 2 of "Building on Windows". - Use title case for "Getting Help" subheading.
|
r? @brson (rust_highfive has picked a reviewer for you, use r? to override) |
|
Also, here's a rendered version. r? @steveklabnik |
| ```sh | ||
| $ git clone https://github.com/rust-lang/rust.git | ||
| $ cd rust | ||
| ``` |
There was a problem hiding this comment.
if we're using triple graves, then we shouldn't need to indent
|
r= me after a few nits, thanks! |
|
@steveklabnik I think the indentation is still necessary in order to keep the code blocks / blockquotes on the same "level" as the ordered lists (unless the content after the code block in step 3 of "Building From Source" should be excluded from the list). The list numberings get messed up if a top-level element appears in the middle of list (see the "Building on Windows" list on the current version of the README). |
|
Ahhhhh |
|
@bors: r+ 24fa6be rollup |
|
@steveklabnik That being said, maybe the paragraph after the note in "Building from Source" should be placed at the top level, since it's just information rather than a "step" to follow; thoughts on that change? |
- Various grammatical changes. - Use triple-backtick syntax and `sh` highlighting for code blocks. - Fix indentation of code block in step 2 of "Building on Windows". - Use title case for "Getting Help" subheading.
- Various grammatical changes. - Use triple-backtick syntax and `sh` highlighting for code blocks. - Fix indentation of code block in step 2 of \"Building on Windows\". - Use title case for \"Getting Help\" subheading.
shhighlighting for code blocks.