Commit Graph

809 Commits

Author SHA1 Message Date
Paul Stansifer
2b5e81c464 Reword some things in the macro tutorial. 2012-12-16 18:45:54 -05:00
Brian Anderson
d4daa78aa3 Update docs for crate file changes 2012-12-15 19:55:25 -08:00
Brian Anderson
e67190a0d2 Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
Brian Anderson
b0fc222fda Fix broken tests 2012-12-14 16:36:32 -08:00
Tim Chevalier
47faeb9228 [docs] Note that types and modules share the same namespace 2012-12-14 15:42:34 -08:00
Brian Anderson
80ef7243ea Remove spawn_listener, spawn_conversation
These are not needed in a pipe-based Rustiverse
2012-12-14 14:59:32 -08:00
Brian Anderson
55c9cf72e3 Merge pull request #4181 from andrew-d/andrew-doc-fix1
Fix example in docs
2012-12-13 17:28:23 -08:00
Andrew Dunham
08b1c841da Rename "to_str" to "make_string" in the docs
There's already a "to_str" impl for string, so it fails here.
2012-12-13 20:07:58 -05:00
Brian Anderson
fa4fbd51f6 Update docs for kind name changes 2012-12-13 15:52:50 -08:00
Tim Chevalier
0138d87f8f Document pub use foo::* in the reference manual
r=brson

Closes #3788
2012-12-12 16:38:36 -08:00
Tim Chevalier
213773ccb2 Fix tasks tutorial tests 2012-12-12 13:38:19 -08:00
Graydon Hoare
645bd98b60 doc: add missing decls to example, r=burningtree. 2012-12-11 13:43:14 -08:00
Tim Chevalier
eb21ced467 Discuss module syntax earlier in the tutorial
as per #3578
2012-12-11 11:23:20 -08:00
Tim Chevalier
65a1287f53 Discuss the Option type a bit in the tutorial
as per #3577
2012-12-11 11:23:20 -08:00
Lindsey Kuper
1ba9419e6c Tutorial typo fixes 2012-12-10 15:59:18 -05:00
Patrick Walton
eba4dadc54 doc: Fix broken doc test. rs=bustage 2012-12-08 11:47:03 -08:00
Tim Chevalier
2c2398ca0d Xfail broken tests 2012-12-07 23:42:58 -08:00
Graydon Hoare
bbc04dbb24 doc: fix busted doctest, r=burningtree. 2012-12-07 14:40:56 -08:00
Tim Chevalier
b4501f4c64 Document pattern ranges a little more
Patches for further documentation of them welcome, but this
is good enough for now.

Closes #1107
2012-12-06 21:52:50 -08:00
Paul Stansifer
3af757631e Be a bit more explicit about the nature of macro RHSes. 2012-12-06 15:01:40 -08:00
Paul Stansifer
d0c2d6c54e Update macro tutorial to recognize item/statement macros and be clearer
about invocation location vs. interpolation location.
2012-12-06 15:01:17 -08:00
Brian Anderson
946427b562 manual: Clarify that Drop types cannot be Copy 2012-11-30 11:23:22 -08:00
Brian Anderson
d1c558394f Fix tutorial's use of Drop 2012-11-29 16:23:24 -08:00
Paul Stansifer
a88f9ac732 Macros can now also be stmts and items. 2012-11-29 12:09:11 -08:00
Damien Grassart
9f290b5669 Fix sample code in the tutorial 2012-11-26 14:41:29 -08:00
Tim Chevalier
e454a47bf2 [tutorial] Use a less confusing closure example
Closes #3996
2012-11-24 09:28:34 -08:00
Brian Anderson
8f22582e9f Fix breakage. Expand const examples in manual 2012-11-19 23:20:37 -08:00
Jesse Jones
ca332a68fa Added optional pub to use_decl EBNF. 2012-11-18 18:28:05 -08:00
Jesse Jones
76712476c2 Slightly better description of macro designators.
Closes #3378
2012-11-18 18:25:06 -08:00
Jesse Jones
a24da7e254 Discuss the types that may be used with const items.
Also removed vector example that doesn't compile. IMO closes #3341.
2012-11-18 17:05:24 -08:00
Jesse Jones
a1bf759783 Added brief discussion of static trait methods.
Closes #3339
2012-11-18 15:49:53 -08:00
Jesse Jones
57c203ef7f Documented copy, ref, move in patterns.
Closes #3337
2012-11-18 15:26:12 -08:00
Jesse Jones
e46de5381b Moved the matching structs example next to the prose talking about struct matching 2012-11-18 15:15:12 -08:00
Jesse Jones
67d421d62d Document [0, ..8] vector syntax.
Closes #3336
2012-11-18 11:36:09 -08:00
Jesse Jones
d106ef88e6 Improved attribute section, mostly by mentioning lint attributes.
Closes #2769
2012-11-18 09:23:09 -08:00
Jesse Jones
d701fcd8a5 Added a readme explaining how to generate html from markdown docs w/o node 2012-11-18 09:08:31 -08:00
Tim Chevalier
12a4130749 Typo 2012-11-15 19:36:48 -08:00
Cat's Eye Technologies
7c35f7ed04 Minor grammatical edits; use preferred nomenclature consistently. 2012-11-11 16:19:40 +00:00
Patrick Walton
2904095570 rustc: Implement the Drop trait. r=brson 2012-11-07 12:34:32 -08:00
Brian Anderson
ed48e76e77 Fix typo in borrowed pointer tutorial. Closes #3876 2012-10-29 13:52:05 -07:00
Tim Chevalier
2ab614f356 Document labeled break and continue in the reference manual
r=brson
2012-10-26 15:00:55 -07:00
Tim Chevalier
0ef75a6965 Document how the compiler disambiguates variable patterns from variant patterns
r=brson
Closes #3851
2012-10-25 15:03:33 -07:00
Tim Chevalier
19dae8dae1 Remove remaining mentions of <- from docs 2012-10-23 12:13:09 -07:00
Tim Chevalier
804c608f01 Remove binary move from the docs 2012-10-23 12:10:03 -07:00
Brian Anderson
5fc4e51ab7 docs: Remove unfinished sentence in manual. Closes #3806 2012-10-22 13:12:16 -07:00
Paul Stansifer
4edb881124 Talk about ends, rather than means, in macro tutorial introduction. 2012-10-20 21:54:25 -04:00
Paul Stansifer
0f2fc71d79 Add examples to the parsing limitations section of the macro tutorial.
(Thanks to bstrie for pointing them out!)
2012-10-17 21:40:39 -04:00
Ben Striegel
f7ce3dc55f Extraneous sigil patrol: turn &[] literals into [] 2012-10-17 11:19:38 -07:00
Ben Striegel
5e1d0bab80 Sigil patrol: change fn@ fn& fn~ to @fn &fn ~fn
This also involves removing references to the old long-form closure
syntax, which pcwalton alleges is deprecated and which was never updated
for the new forms, e.g. `@fn() {}` is illegal.
2012-10-17 11:19:38 -07:00
Ben Striegel
e94e82cb8e Extraneous sigil patrol: ~"string literals" 2012-10-17 11:19:38 -07:00
Niko Matsakis
a92c3db0b3 add missing pub from multifile example in sec 12.3 2012-10-16 20:20:18 -07:00
Tim Chevalier
ea5e3d21ff Make moves explicit in doc examples
Had to remove the buffalo example. It was awkward to update for
explicit moves.
2012-10-12 20:43:37 -07:00
Tim Chevalier
45d1cd83ab Copyedit "Items and attributes" section in docs
Most notably, I removed the "foldl" example in the section on pure functions,
as IIRC this is no longer something you need an unsafe block for
(pure functions are as pure as their arguments). Feel free to add
an example where an unsafe block really is needed.
2012-10-12 12:02:08 -07:00
Brian Anderson
39c0d3591e Merge pull request #3734 from dbp/tutorial-fixes
tutorial: add note about mutability of vectors
2012-10-11 21:01:16 -07:00
Daniel Patterson
c33bff9557 tutorial: add note about mutability of vectors 2012-10-11 23:13:04 -04:00
Tim Chevalier
91315c3c2f manual: Lightly copyedit the crates section 2012-10-11 20:09:41 -07:00
Tim Chevalier
bb4dd06307 manual: Lightly copyedit the macros section 2012-10-11 20:03:24 -07:00
Tim Chevalier
140d16ac58 Fix tutorial-ffi tests 2012-10-11 19:45:04 -07:00
Graydon Hoare
5bca5f7c54 manual: fix one more nit. 2012-10-11 19:39:21 -07:00
Graydon Hoare
588d97d80e manual: fix accidentally broken test. 2012-10-11 19:30:43 -07:00
Graydon Hoare
13ea16152d manual: remove as many ~[] literals as possible. 2012-10-11 19:25:09 -07:00
Graydon Hoare
d81d4f1f3c manual: remove as many ~"" literals as possible. 2012-10-11 19:22:53 -07:00
Graydon Hoare
0b1a401bb7 manual: fix bullet list. 2012-10-11 19:15:40 -07:00
Graydon Hoare
d471e24214 manual: remove description of references (modes) from memory-slots section. 2012-10-11 19:12:35 -07:00
Graydon Hoare
70909533f0 manual: rewrite the section on type kinds. 2012-10-11 19:07:38 -07:00
Graydon Hoare
9bbff50c14 manual: fix various examples. 2012-10-11 18:18:53 -07:00
Graydon Hoare
089e257769 manual: capitalize more examples properly. 2012-10-11 18:18:53 -07:00
Graydon Hoare
9ea5e6a3b2 manual: fix vec and str types to discuss definite / indefinite size. 2012-10-11 18:18:53 -07:00
Graydon Hoare
45dc69d887 manual: example fixup. 2012-10-11 18:18:53 -07:00
Graydon Hoare
196cc0265c manual: add 'item', remove statement that built-in types are keywords. 2012-10-11 18:18:53 -07:00
Graydon Hoare
a1c831be25 manual: avoid describing 'assert' as 'like check', note future removal. 2012-10-11 18:18:53 -07:00
Graydon Hoare
73d4417dc7 manual: remove 'analogy' between return and return. meaningless. 2012-10-11 18:18:53 -07:00
Graydon Hoare
544d36bc4d manual: fixes to match expression examples and explanation. 2012-10-11 18:18:53 -07:00
Graydon Hoare
533cce8050 manual: remove unusual production name in match-expr grammar. 2012-10-11 18:18:53 -07:00
Graydon Hoare
1d69b81eef manual: "to" -> ".." 2012-10-11 18:18:53 -07:00
Graydon Hoare
515f88f1c1 manual: rewrite for-expression section to reflect this year's definition. 2012-10-11 18:18:53 -07:00
Graydon Hoare
fd85a0000a manual: add section on do-expressions. 2012-10-11 18:18:53 -07:00
Graydon Hoare
1a885f6be1 manual: add section on lambda expressions. 2012-10-11 14:42:11 -07:00
Graydon Hoare
2bb141c1f9 manual: remove mention of do-while loops. 2012-10-11 14:20:40 -07:00
Graydon Hoare
04e6b09c58 manual: remove mention of >>>. 2012-10-11 14:19:48 -07:00
Graydon Hoare
44f8a8ec5a manual: remove 'trivial cast', it's an unused definition. 2012-10-11 14:18:52 -07:00
Graydon Hoare
1d47c0a830 manual: note overloading and traits for comparison ops. 2012-10-11 14:18:52 -07:00
Graydon Hoare
eff4a36b3e manual: mention overloading, traits on the arithmetic and bitwise operators. 2012-10-11 14:18:52 -07:00
Graydon Hoare
edf493f07b manual: fix exponents on number types. 2012-10-11 14:18:52 -07:00
Graydon Hoare
3a2e9e404a manual: s/unique/owned/, s/shared/managed/, fix rval/lval more. 2012-10-11 14:18:52 -07:00
Tim Chevalier
41bce91cb8 Fix tutorial link to tasks
Closes #3715
2012-10-11 14:17:59 -07:00
Graydon Hoare
c87ff5e29e manual: remove box-specific language. 2012-10-11 13:13:58 -07:00
Graydon Hoare
382e85c14f manual: "with" -> ".." for FRU. 2012-10-11 13:12:29 -07:00
Graydon Hoare
2c34ffa26f manual: link to expressions in lval/rval section. 2012-10-11 13:11:21 -07:00
Graydon Hoare
c46706fffd manual: add borrow operator to symbolic unary operator list; mention copy and move. 2012-10-11 13:11:07 -07:00
Graydon Hoare
e257f390e1 manual: add section for unary move expressions. 2012-10-11 13:10:43 -07:00
Graydon Hoare
009cf535a4 manual: add section for path expressions. 2012-10-11 13:10:20 -07:00
Graydon Hoare
43fd84a607 Fix doctest. 2012-10-11 12:49:52 -07:00
Graydon Hoare
25d8ca153e manual: pluralize; decls can introduce multiple names. 2012-10-11 12:25:25 -07:00
Graydon Hoare
78f29f2b14 manual: remove vestigial mention of tasking from definition of statement (long story, been there since first public release). 2012-10-11 12:21:32 -07:00
Graydon Hoare
c2fd04f66a manual: s/Self type/Self types/. 2012-10-11 12:12:31 -07:00
Graydon Hoare
a8e1d83103 manual: remove all mention of constraints. 2012-10-11 12:10:01 -07:00
Graydon Hoare
c4237db60e manual: capitalize examples, remove mention of named impls, change RC -> managed, clarify language. 2012-10-11 12:07:02 -07:00
Graydon Hoare
06a17a7ce5 manual: disambiguate field expressions from method-call expressions. 2012-10-11 11:57:12 -07:00
Graydon Hoare
d81196ce96 manual: improve description of traits. 2012-10-11 11:47:46 -07:00
Graydon Hoare
9cba4af243 manual: describe structs, split out handling of recursion from enums, deprecate records. 2012-10-11 11:47:27 -07:00
Graydon Hoare
0673b49b05 manual: remove mention of tags, now very obsolete. 2012-10-11 10:43:18 -07:00
Graydon Hoare
dfd00ec8a8 manual: link to kinds, remove kind-list. 2012-10-11 10:42:46 -07:00
Graydon Hoare
bc68a88593 manual: improve description of unsafe functions. 2012-10-11 10:41:24 -07:00
Graydon Hoare
9e6df28277 manual: capitalize 'Copy'. 2012-10-11 10:38:07 -07:00
Graydon Hoare
a2cace473b manual: remove a mode. 2012-10-11 10:36:37 -07:00
Graydon Hoare
c9cee7c2af Reorder function sections. 2012-10-11 10:33:32 -07:00
Graydon Hoare
860573e3e0 Reword para on diverging functions. 2012-10-11 10:31:57 -07:00
Graydon Hoare
012bb7de5b Typo: an -> a. 2012-10-11 10:23:24 -07:00
Tim Chevalier
39acb06503 Copyedit sections 11-13 of the tutorial. That's all, folks! 2012-10-10 21:29:25 -07:00
Tim Chevalier
6d250517ed Copyedit sections 9 and 10 of the tutorial 2012-10-10 21:06:22 -07:00
Tim Chevalier
7582a482c6 Copyedit sections 7 and 8 of the tutorial 2012-10-10 20:52:20 -07:00
Tim Chevalier
1a8b00a03a Copyedit sections 5 and 6 of the tutorial 2012-10-10 20:35:33 -07:00
Tim Chevalier
d7b8512eae Copyedit section 4 of tutorial 2012-10-10 20:08:08 -07:00
Tim Chevalier
6627ac6623 Copyedit section 3 of tutorial 2012-10-10 19:32:11 -07:00
Tim Chevalier
38ccaed4ce Copyedit sections 1 and 2 of tutorial 2012-10-10 19:05:13 -07:00
Brian Anderson
b7b2217976 Update tutorial install instructions 2012-10-10 17:56:23 -07:00
Graydon Hoare
3d31a6b899 Remove several references to resources; add section for Constants. 2012-10-10 17:18:12 -07:00
Graydon Hoare
cad6733db5 Remove mention of res_item, add const_item. Reword a bit. 2012-10-10 17:18:12 -07:00
Graydon Hoare
ff37c65f5c Remove mention of argv. 2012-10-10 17:18:12 -07:00
Graydon Hoare
304a2455c0 Mention deprecation of crate files. 2012-10-10 17:18:12 -07:00
Graydon Hoare
c639f44adb Tidy up macro_rules grammar. 2012-10-10 17:18:12 -07:00
Graydon Hoare
58807b0500 Mention doc comments. 2012-10-10 17:18:12 -07:00
Graydon Hoare
19f1c3174f Remove mention of block-comment nesting. 2012-10-10 17:18:12 -07:00
Graydon Hoare
8f9bb5d203 Fix markings about future in manual, remove out-of-date marker. 2012-10-10 17:18:12 -07:00
Graydon Hoare
d81a7aba3c Minor fixes to the runtime and scheduling part of manual. 2012-10-10 17:18:12 -07:00
Graydon Hoare
056fc13e10 Mention other languages. 2012-10-10 17:18:12 -07:00
Tim Chevalier
de4687c378 Copyedit sections 9-11 of the borrowed pointer tutorial (last edits from me) 2012-10-10 15:04:42 -07:00
Tim Chevalier
448c349234 Copyedit sections 7 and 8 of the borrowed pointer tutorial 2012-10-10 14:49:07 -07:00
Tim Chevalier
ae861f0288 Copyedit sections 5 and 6 of the borrowed pointer tutorial 2012-10-10 14:29:16 -07:00
Tim Chevalier
f4a6b84a65 Copyedit sections 3 and 4 of the borrowed pointer tutorial 2012-10-10 13:56:42 -07:00
Patrick Walton
d9317a174e doc: Tweak the wording of the memory model goals 2012-10-09 21:39:18 -07:00
Patrick Walton
6da09c3b43 doc: Fix some inaccuracies in the tutorial.
* Pointers can refer to stack objects as well as heap objects.

* Non-managed types can be cyclic if an arena is used.
2012-10-09 21:24:28 -07:00
Graydon Hoare
f016fd43f8 Remove section on 'note' expressions, they won't exist. 2012-10-09 20:05:41 -07:00
Graydon Hoare
fe1165f561 Tighten up language surrounding declarations, assignments, inits, lvals. 2012-10-09 20:05:41 -07:00
Tim Chevalier
a46db484ab Copyedit first two sections of borrowed pointer tutorial 2012-10-09 17:12:34 -07:00
Tim Chevalier
cd6f24f9d1 Copyedit FFI tutorial 2012-10-09 16:46:16 -07:00
Tim Chevalier
4b3be853af Copyedit tasks tutorial 2012-10-09 16:14:55 -07:00
Graydon Hoare
28cf16a304 Fix tutorial breakage. 2012-10-09 15:33:24 -07:00
Tim Chevalier
0aa42bc91e Copyedit the macro tutorial
I hope I haven't introduced any grievous errors :-)
2012-10-09 14:40:23 -07:00
tav
4c968f47e0 doc: Remove duplicate word typo in the tutorial. 2012-10-09 01:30:46 +01:00
Brian Anderson
f5c3af1c1a Clean up unfinished portions of task tutorial 2012-10-07 21:29:47 -07:00
Brian Anderson
2a41abb9ef Work on the tutorial section on 'do' 2012-10-07 01:52:06 -07:00
Brian Anderson
07fb35227b Tutorial 2012-10-07 01:06:07 -07:00
Brian Anderson
f0c4140dd0 More tutorial tweaking 2012-10-06 22:57:40 -07:00
Brian Anderson
c6330036a4 'The' Rust Language Tutorial 2012-10-06 22:47:26 -07:00
Brian Anderson
b6443519c8 Remove some redundant info from tutorial 2012-10-06 22:45:48 -07:00
Brian Anderson
fe5526f49c docs: Fix capitalization of section title 2012-10-06 22:40:12 -07:00
Brian Anderson
ba26dc50ce docs: Remove more uses of records 2012-10-06 22:35:08 -07:00
Jacob Harris Cryer Kragh
0b2ffa5692 tutorial: Add missing struct name 2012-10-06 22:33:09 -07:00