Skip to content

README: make it clear rustc is the compiler #26373

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

Merged
merged 1 commit into from
Jul 1, 2015
Merged

README: make it clear rustc is the compiler #26373

merged 1 commit into from
Jul 1, 2015

Conversation

tshepang
Copy link
Member

No description provided.

@rust-highfive
Copy link
Contributor

r? @nikomatsakis

(rust_highfive has picked a reviewer for you, use r? to override)

@nagisa
Copy link
Member

nagisa commented Jun 18, 2015

I think current text makes it pretty clear rustc is, in fact, the Rust compiler.

@tshepang
Copy link
Member Author

@nagisa the listing made it look like The Rust compiler and rustc could be different things, so this PR makes it more clear.

@liigo
Copy link
Contributor

liigo commented Jun 19, 2015

Yes, it was already clear.
On Jun 19, 2015 01:14, "Simonas Kazlauskas" [email protected]
wrote:

I think current text makes it pretty clear rustc is, in fact, the Rust
compiler.


Reply to this email directly or view it on GitHub
#26373 (comment).

@tshepang
Copy link
Member Author

@nikomatsakis only to those who are already aware that rustc is the Rust compiler

@nagisa
Copy link
Member

nagisa commented Jun 19, 2015

@tshepang current sentence correctly uses an appositive which

identifies or renames another word in a sentence--most often a noun that immediately precedes it.
-- about.com

I strongly suggest checking out the examples in linked pages if you are not convinced.

@tshepang
Copy link
Member Author

@nagisa I am aware of that usage, and that the English used here is valid. To prove it, here's another alternative that would also make things less ambiguous:

This repo contains the code for rustc, the Rust compiler. It also contains standard libraries, tools and documentation for Rust.

That's less ambiguous than the current:

This repo contains the code for rustc, the Rust compiler, as well as standard libraries, tools and documentation for Rust.

@soltanmm
Copy link

Given that we've all seen typos, poor grammar, and the like peppering various code-related documents, there is at least one possibility of ambiguity in the original sentence. This possible ambiguity arises between parsing the sentence as having poor grammar and parsing the sentence as exactly written. The change given uses English language features such as the parenthetical to significantly decrease the possibility of that ambiguity for readers skimming the text. I think this is a pragmatic change from that perspective.

@tshepang
Copy link
Member Author

Support finally! Thanks @soltanmm.

@@ -4,7 +4,7 @@ Rust is a systems programming language that is fast, memory safe and
multithreaded, but does not employ a garbage collector or otherwise
impose significant runtime overhead.

This repo contains the code for `rustc`, the Rust compiler, as well
This repo contains the code for the compiler (`rustc`), as well
Copy link
Member

Choose a reason for hiding this comment

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

What if we just remove the comma separation, and write it like this? This repo contains the code for the Rust compiler rustc, as well as standard libraries, tools and documentation for Rust.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the English with your suggestion is not valid, given the meaning intended.

@steveklabnik
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Jun 30, 2015

📌 Commit 1cf6a82 has been approved by steveklabnik

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jun 30, 2015
bors added a commit that referenced this pull request Jun 30, 2015
@bors bors merged commit 1cf6a82 into rust-lang:master Jul 1, 2015
@tshepang tshepang deleted the patch-2 branch July 1, 2015 14:10
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.

9 participants