Commit Graph

280 Commits

Author SHA1 Message Date
Steve Klabnik
40c93504dd Update the TOC for ownership.
Here's a rough summary of notes from @aturon and I's discussion about
this:

Topics:
    - heap vs stack
    - pointers
    - slices
    - scope/drops

- Ownership
    - confusion around allocating strings vs literals
    - String::new and String.push
    - or do we use String::from?
    - scope/drops
     - Move vs copy

- Borrowing
    - Rust's take on pointers to entire objects

- Memory layout
    - heap vs stack -- what does it mean to own a String -- what even is
      a String??
    - talk in terms of box and arrow diagrams, rather than address
      spaces etc
    - keep a high level of conceptual abstraction
    - pointers

- Slices
    - Rust's take on *interior* pointers
    - Niko argues that slices and borrowing from fields of a struct are
      conceptually related
    - Sing the praises of slices wrt safety!
    - We get to address string literals very early!
    - Sidebar on literals and rodata

- Advanced: lifetimes
2016-01-12 14:35:10 -05:00
Steve Klabnik
fd2dc5e2e0 Add stuff about nostarch 2016-01-08 12:09:26 -05:00
Steve Klabnik
fc634adba1 remove my home directory from path names 2016-01-08 11:54:15 -05:00
Steve Klabnik
8383d67cd7 Primitive Rust -> 'up and running'
primitive feels bad for a number of reasons, let's try this
2016-01-08 11:41:07 -05:00
Steve Klabnik
b50e0a439b these chapters aren't ready yet 2016-01-08 11:37:51 -05:00
Steve Klabnik
3092afb040 Merge pull request #56 from azerupi/master
Fix typos
2016-01-03 19:04:35 -05:00
Mathieu David
6ae257b276 Fix typos 2016-01-04 00:34:27 +01:00
Steve Klabnik
c784b1cda2 Grey out a lot of the TOC
Take advantage of an mdBook feature to grey these out. This will also
help with the "what is draft ready and what isn't" bit
2015-12-30 11:24:16 -05:00
Steve Klabnik
98bd2931dc @aturon feedback on if
https://github.com/rust-lang/book/issues/9#issuecomment-167879371
2015-12-29 17:36:30 -05:00
Steve Klabnik
db59879a46 just don't talk about inner doc comments 2015-12-29 17:36:30 -05:00
Steve Klabnik
f6534b1754 Update types chapters as per @aturon's feedback 2015-12-29 17:36:30 -05:00
Steve Klabnik
ff1b2b8a13 name section headings more consistently 2015-12-29 17:36:30 -05:00
Steve Klabnik
1a6899070f Split up primitive types into scalar and compound types
In the process, drop &str and fn.
2015-12-29 17:36:30 -05:00
Steve Klabnik
78d0bcdf28 Merge pull request #54 from azerupi/master
Add disclaimer about the book being in progress on all rendered pages
2015-12-29 17:01:48 -05:00
Mathieu David
62129f393d Add disclaimer about the book being in progress on handlebars template so that it shows on all pages of the rendered book 2015-12-29 22:48:51 +01:00
Steve Klabnik
8898dcf0ea Merge pull request #51 from clemensw/structs_typo
Fix trivial typo
2015-12-29 10:59:19 -05:00
Steve Klabnik
5cd39dadb6 Merge pull request #52 from clemensw/structs_compare_to_tuples
Example Point changes coordinates.
2015-12-29 10:58:54 -05:00
Clemens Wehrmann
799b5034cc Example Point changes coordinates.
When the implementation a point moves from tuple to struct, the point coordinates should remain the same to avoid confusion.
2015-12-29 09:53:08 +01:00
Clemens Wehrmann
3ce0088384 Fix trivial typo 2015-12-29 09:43:45 +01:00
Steve Klabnik
aad634e61d mdbook doesn't default to rust
In rustdoc, I don't need the Rust, but here I do.
2015-12-28 14:47:49 -05:00
Steve Klabnik
00bb4e1a8f whoops, forgot an ignore 2015-12-28 13:01:43 -05:00
Steve Klabnik
fbe9c79b59 first draft of structs 2015-12-28 12:38:29 -05:00
Steve Klabnik
8bea051a27 modify TOC to match the one we discussed
nice catch @aturon
2015-12-28 12:36:56 -05:00
Steve Klabnik
7afd6feada undo the 'sentence per line' experiment
I tried it, I didn't like it.
2015-12-28 10:51:03 -05:00
Steve Klabnik
795403668e book.json should be at the top level
oops:
2015-12-28 10:37:36 -05:00
Steve Klabnik
b969a4f281 Merge pull request #40 from Keats/master
Fix primitive types typo
2015-12-24 12:45:22 -05:00
Vincent Prouillet
f67d7a7ac9 Fix primitive types typo 2015-12-24 12:20:55 +00:00
Steve Klabnik
f5d8e9af9a Merge pull request #38 from Keats/master
Add local documentation subtitle for installation section
2015-12-22 12:55:28 -05:00
Vincent Prouillet
65232c01ae Add local documentation subtitle for installation section 2015-12-22 17:53:13 +00:00
Steve Klabnik
3612ad7f40 Merge pull request #37 from rphmeier/master
Typo fix: parenthesis -> parentheses
2015-12-22 11:20:59 -05:00
Robert Habermeier
5663b5e2df Typo fix: parenthesis -> parentheses 2015-12-22 11:06:51 -05:00
Steve Klabnik
a6d7ea95ea Merge pull request #36 from jFransham/patch-1
Fix typo in primitive-types
2015-12-22 09:58:46 -05:00
Jack Fransham
07688ef791 Fix typo in primitive-types 2015-12-22 09:17:40 +00:00
Steve Klabnik
9c99e98b53 these are labels, not issues
thanks @aturon
2015-12-21 14:03:31 -05:00
Steve Klabnik
cb80294996 some tweaks for functions 2015-12-21 13:01:14 -05:00
Steve Klabnik
2c42421da8 tweaks to 'variable bindings' 2015-12-21 12:57:18 -05:00
Steve Klabnik
2718b63675 some tweaks to 'primitive rust' 2015-12-21 12:45:48 -05:00
Steve Klabnik
7e8d9204f4 The basics -> primitive rust 2015-12-21 12:44:20 -05:00
Steve Klabnik
26bc17b77e ignore some things I forgot to ignore 2015-12-21 12:37:59 -05:00
Steve Klabnik
c4d814b1bc ignore that example 😅 2015-12-21 12:34:51 -05:00
Steve Klabnik
3d226477b6 draft of loops 2015-12-21 12:34:20 -05:00
Steve Klabnik
a1905f2a58 first draft of if 2015-12-21 11:40:55 -05:00
Steve Klabnik
ff6e452410 Merge pull request #34 from rust-lang/section_three
First draft of primitive types
2015-12-18 14:48:13 -05:00
Steve Klabnik
d3818036d0 Add label information to the README. 2015-12-18 14:48:16 -05:00
Steve Klabnik
e5a99e8cbc First draft of primitive types
I moved slices to references, since they are references, and explaining
them right now is just more complex. I might do that with `&str` too...
2015-12-18 14:37:58 -05:00
Steve Klabnik
1117de1885 Merge pull request #33 from rust-lang/section_three
First half of primitive types
2015-12-18 11:05:25 -05:00
Steve Klabnik
a4227840d7 First half of primitive types 2015-12-18 10:34:07 -05:00
Steve Klabnik
141af75888 Merge pull request #32 from rust-lang/section_three
new chapter: comments
2015-12-17 14:51:12 -05:00
Steve Klabnik
187c8c2025 new chapter: comments 2015-12-17 14:38:30 -05:00
Steve Klabnik
7d0b22d9e2 Merge pull request #31 from rust-lang/section_three
new chapter: functions
2015-12-17 14:11:02 -05:00