TRPL: new introduction #24239

steveklabnik · 2015-04-09T16:48:50Z

Now that the new TOC has landed, I've started doing an editing pass to get the old content into the right shape. I felt this introduction was significant enough to send as its own PR, though, as it's the introduction.

It's possible that we may just want to replace 'the intro' with this directly, but this PR doesn't do that.

rust-highfive · 2015-04-09T16:49:01Z

r? @huonw

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

apasel422 · 2015-04-09T16:57:12Z

src/doc/trpl/README.md

-Rust. It has individual sections on each part of Rust's syntax.
+* [Getting started][gs] - Set up your computer for Rust development.
+* [Learn Rust][lr] - Learn Rust programming through small projects.
+* [Effective Rust][er] - Higher level concepts for writing excellent Rust code.


s/Higher level/Higher-level/

nice catch, fixing

tshepang · 2015-04-09T19:36:55Z

src/doc/trpl/README.md

+requirements, and writing low-level code, like device drivers and operating
+systems. It improves on current languages targeting this space by having a
+number of compile-time safety checks that produce no runtime overhead, but
+eliminate all data races. These checks can be used to form ‘zero-cost


"but eliminate" -> "while eliminating"

nice catch, thanks

tshepang · 2015-04-09T19:47:41Z

src/doc/trpl/README.md

+or ‘Syntax and Semantics’, depending on your preference: ‘Learn Rust’ if you
+want to dive in with a project, or ‘Syntax and Semantics’ if you prefer to
+start small, and learn a single concept thoroughly before moving onto the next.
+Copious cross-linking will help connect these parts together.


Not sure if this line is helpful.

I think in general I'm a bit more verbose than you are in this. :)

This one will probably help some readers relax

The future tense sounds a little weird to me, maybe make it live in now more :P ("copious cross-linking connects these parts together"?)

tshepang · 2015-04-09T20:23:35Z

src/doc/trpl/README.md

+```rust
+fn main() {
+    let x = vec![1, 2, 3];
+


I find these extra spaces ugly. Also, it's not what's going to happen in real code, and the differences are visible enough anyways. I'd rather you do this if you want emphasis:

fn main() { let x = vec![1, 2, 3]; let y = &x[0]; // added }

then

fn main() { let x = vec![1, 2, 3]; let y = &x[0]; x.push(4); // added }

it's not what's going to happen in real code

If I were to write this code for real, I would put those spaces there. The principle is 'coding in paragraphs', each separate thing gets a newline. In more real code, there might be two or three things between each space, but I find your version to be quite cramped.

huonw · 2015-04-09T23:20:16Z

src/doc/trpl/README.md


-This chapter contains things that are only available on the nightly channel of
-Rust.
+```rust


Is this code example really worth the space in the brief intro? This seems like a case when space is at a premium and we want to make it as "tight" as reasonable. It seems to me that the paragraph above is probably all that's needed, or even reduced further with some cross-links to more explanations (Rust is statically typed but has type inference, so type annotations are [optional](...)).

huonw · 2015-04-09T23:28:32Z

(All my comments are meant to be discussion starters, I'm not rabidly in favour of any of them, just wondering if we could cargo doc --release a little. :P )

steveklabnik · 2015-04-10T00:42:31Z

I want to land this so that it gets into the nightly tonight. If there's any more nits, please open an issue and I'll just take care of it, but I don't want to have another day with the intro being just straight-up wrong. :)

steveklabnik · 2015-04-10T00:42:34Z

@bors: r+ rollup

bors · 2015-04-10T00:42:35Z

📌 Commit bf88539 has been approved by steveklabnik

…labnik Now that the new TOC has landed, I've started doing an editing pass to get the old content into the right shape. I felt this introduction was significant enough to send as its own PR, though, as it's the introduction. It's possible that we may just want to replace 'the intro' with this directly, but this PR doesn't do that.

- Successful merges: #24121, #24234, #24236, #24239, #24240, #24243, #24244, #24245, #24247, #24253 - Failed merges:

…labnik Now that the new TOC has landed, I've started doing an editing pass to get the old content into the right shape. I felt this introduction was significant enough to send as its own PR, though, as it's the introduction. It's possible that we may just want to replace 'the intro' with this directly, but this PR doesn't do that.

liigo · 2015-04-10T07:05:58Z

src/doc/trpl/README.md

+
+    let y = x[0].clone();
+
+    x.push(4);


Why push an integer to a vector of &str?

…labnik Now that the new TOC has landed, I've started doing an editing pass to get the old content into the right shape. I felt this introduction was significant enough to send as its own PR, though, as it's the introduction. It's possible that we may just want to replace 'the intro' with this directly, but this PR doesn't do that.

- Successful merges: #24121, #24234, #24236, #24239, #24240, #24242, #24243, #24244, #24245, #24247, #24253, #24259 - Failed merges:

…labnik Now that the new TOC has landed, I've started doing an editing pass to get the old content into the right shape. I felt this introduction was significant enough to send as its own PR, though, as it's the introduction. It's possible that we may just want to replace 'the intro' with this directly, but this PR doesn't do that.

Manishearth · 2015-04-11T15:39:01Z

Needs 0a2885a

rust-highfive assigned huonw Apr 9, 2015

apasel422 reviewed Apr 9, 2015
View reviewed changes

steveklabnik force-pushed the editing_pass branch from 54b33a9 to e9426f7 Compare April 9, 2015 17:28

tshepang reviewed Apr 9, 2015
View reviewed changes

steveklabnik force-pushed the editing_pass branch from e9426f7 to d9a78a0 Compare April 9, 2015 19:38

tshepang reviewed Apr 9, 2015
View reviewed changes

steveklabnik force-pushed the editing_pass branch from d9a78a0 to a0ebd5e Compare April 9, 2015 20:12

tshepang reviewed Apr 9, 2015
View reviewed changes

steveklabnik force-pushed the editing_pass branch from a0ebd5e to db058f8 Compare April 9, 2015 23:09

huonw reviewed Apr 9, 2015
View reviewed changes

steveklabnik force-pushed the editing_pass branch 2 times, most recently from 2be0873 to 90d6965 Compare April 9, 2015 23:38

TRPL: new introduction

bf88539

steveklabnik force-pushed the editing_pass branch from 90d6965 to bf88539 Compare April 9, 2015 23:39

steveklabnik mentioned this pull request Apr 10, 2015

Rollup of 10 pull requests #24255

Closed

bors added a commit that referenced this pull request Apr 10, 2015

Auto merge of #24255 - steveklabnik:rollup, r=steveklabnik

abab8a6

- Successful merges: #24121, #24234, #24236, #24239, #24240, #24243, #24244, #24245, #24247, #24253 - Failed merges:

Manishearth mentioned this pull request Apr 10, 2015

Rollup of 14 pull requests #24260

Closed

liigo reviewed Apr 10, 2015
View reviewed changes

steveklabnik mentioned this pull request Apr 10, 2015

Rollup of 12 pull requests #24265

Closed

bors added a commit that referenced this pull request Apr 10, 2015

Auto merge of #24265 - steveklabnik:rollup, r=steveklabnik

1089011

- Successful merges: #24121, #24234, #24236, #24239, #24240, #24242, #24243, #24244, #24245, #24247, #24253, #24259 - Failed merges:

steveklabnik mentioned this pull request Apr 10, 2015

Rollup of 15 pull requests #24284

Closed

steveklabnik mentioned this pull request Apr 10, 2015

Rollup of 17 pull requests #24293

Closed

steveklabnik mentioned this pull request Apr 10, 2015

Rollup of 16 pull requests #24297

Closed

steveklabnik mentioned this pull request Apr 10, 2015

Rollup of 18 pull requests #24302

Closed

Manishearth added a commit to Manishearth/rust that referenced this pull request Apr 11, 2015

Fix readme doctest (fixup rust-lang#24239)

0a2885a

bors merged commit bf88539 into rust-lang:master Apr 11, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TRPL: new introduction #24239

TRPL: new introduction #24239

steveklabnik commented Apr 9, 2015

rust-highfive commented Apr 9, 2015

apasel422 Apr 9, 2015

steveklabnik Apr 9, 2015

tshepang Apr 9, 2015

steveklabnik Apr 9, 2015

tshepang Apr 9, 2015

steveklabnik Apr 9, 2015

tshepang Apr 9, 2015

huonw Apr 9, 2015

steveklabnik Apr 9, 2015

tshepang Apr 9, 2015

steveklabnik Apr 9, 2015

huonw Apr 9, 2015

steveklabnik Apr 9, 2015

huonw commented Apr 9, 2015

steveklabnik commented Apr 10, 2015

steveklabnik commented Apr 10, 2015

bors commented Apr 10, 2015

liigo Apr 10, 2015

steveklabnik Apr 10, 2015

Manishearth commented Apr 11, 2015

TRPL: new introduction #24239

TRPL: new introduction #24239

Conversation

steveklabnik commented Apr 9, 2015

rust-highfive commented Apr 9, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

huonw commented Apr 9, 2015

steveklabnik commented Apr 10, 2015

steveklabnik commented Apr 10, 2015

bors commented Apr 10, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Manishearth commented Apr 11, 2015