Skip to content

Conversation

@parir
Copy link
Contributor

@parir parir commented Aug 9, 2014

This PR fixes some minor grammar and spelling issues in the guide.

src/doc/guide.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rust is already the default in rustdoc for code blocks.

Additionally, the {} is not necessary for adding a single attribute to a code block.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This basically just fixes syntax highlighting if you read it on GitHub.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I revert this change?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually do want all of them to have the {rust}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll concede to your desires on the subject of guides, though I still maintain that the {} is unnecessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So what should we do? Leave it as it is and maybe open a seperate PR for this issue?

@parir
Copy link
Contributor Author

parir commented Aug 11, 2014

@kballard PTAL.

@lilyball
Copy link
Contributor

LGTM. I just edited your PR description to remove the strikethrough because bors uses that in the merge commit.

bors added a commit that referenced this pull request Aug 11, 2014
This PR fixes some minor grammar and spelling issues in the guide.
@bors bors closed this Aug 11, 2014
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.

4 participants