Fix some minor issues in the guide. #16379
Conversation
| @@ -1417,7 +1417,7 @@ We now loop forever with `loop`, and use `break` to break out early. | |||
| `continue` is similar, but instead of ending the loop, goes to the next | |||
| iteration: This will only print the odd numbers: | |||
|
|
|||
| ``` | |||
| ```{rust} | |||
There was a problem hiding this comment.
rust is already the default in rustdoc for code blocks.
Additionally, the {} is not necessary for adding a single attribute to a code block.
There was a problem hiding this comment.
This basically just fixes syntax highlighting if you read it on GitHub.
There was a problem hiding this comment.
Which is rather irrelevant. I don't have any objection to new documentation using
```rust
but I don't think this is a good reason to add unnecessary modifications.
There was a problem hiding this comment.
Hmm. I just imitated what was already there. "```{rust}" is used all over the place in the guide.
Edit: "```rust" is also used quite frequently. This needs some consistency. :)
There was a problem hiding this comment.
Should I revert this change?
There was a problem hiding this comment.
I actually do want all of them to have the {rust}
There was a problem hiding this comment.
I'll concede to your desires on the subject of guides, though I still maintain that the {} is unnecessary.
There was a problem hiding this comment.
So what should we do? Leave it as it is and maybe open a seperate PR for this issue?
|
@kballard PTAL. |
|
LGTM. I just edited your PR description to remove the strikethrough because bors uses that in the merge commit. |
This PR fixes some minor grammar and spelling issues in the guide.
This PR fixes some minor grammar and spelling issues in the guide.