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

Lots of extraneous commas in Guide #334

Closed
alexreg opened this issue May 10, 2016 · 4 comments
Closed

Lots of extraneous commas in Guide #334

alexreg opened this issue May 10, 2016 · 4 comments

Comments

@alexreg
Copy link

alexreg commented May 10, 2016

It should be evident where these occurrences are: http://doc.crates.io/guide.html

@steveklabnik
Copy link
Member

It is not evident, that's why they're there 😉 Specifics would be appreciated.

@alexreg
Copy link
Author

alexreg commented May 10, 2016

Okay, here are some examples of bad commas and other punctuation issues:

Cargo is a tool that allows Rust projects to declare their various dependencies, and ensure that you’ll always get a repeatable build.

This is called a manifest, and it contains all of the metadata that Cargo needs to compile your project. – semicolon preferable to , and

Now, if regex gets updated, we will still build with the same revision, until we choose to cargo update. (last comma)

This would be bad, because we want reproducible builds.

When we’re ready to opt in to a new version of the library, Cargo can re-calculate the dependencies, and update things for us: (last comma)

You find a bug in conduit, and you want to write a patch.

@carols10cents
Copy link
Member

I'm addressing most of these and some others, but I disagree with:

This is called a manifest, and it contains all of the metadata that Cargo needs to compile your project. – semicolon preferable to , and

You find a bug in conduit, and you want to write a patch.

I think those are fine.

@alexreg
Copy link
Author

alexreg commented May 13, 2016

Fair enough. Thanks for taking this on board at least. I know there were some other ones too, so glad you found some.

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

No branches or pull requests

3 participants