Commit Graph

844 Commits

Author SHA1 Message Date
Felix S. Klock II
2dda6d6f5d Formatting cleanup.
I had put a line break in to try to stress the binding of mycircle,
but generated document looks cleaner without newline.
2013-01-29 11:28:52 +01:00
Felix S. Klock II
6cabe2b902 Fixed two examples of erroneous code so their errors match expectation.
1. In the first case, the previous code was failing during type inference
   due to mismatched structure.  Fix is to use the X structure at both
   points in the code.

2. In the second case, a naive transcription that subsitutes *nothing*
   in for the omitted statements signified by "..." will actually
   compile without an error.  Furthermore, any pure code could also be
   substituted for the ellipsis and the code would compile (as the
   text already states).  So to make the example more illustrative, it
   would be better to include an impure callback, which makes the
   potential for aliasing immediately obvious to the reader.
2013-01-29 11:28:52 +01:00
Felix S. Klock II
88bec09e63 Fix two code examples in main rust tutorial.
1. The section on trait definitions of static methods should include
   a trait with a static method in the generated document.

2. The section on trait inheritance had a expression that appears
   nonsensical ("let mycircle = @mycircle") in the generated document.
   The text would be clearer (IMO) if we continued with the running
   example of CircleStruct.
2013-01-29 11:28:52 +01:00
John Clements
18f1dba510 doc typo 2013-01-25 11:58:33 -08:00
Tim Chevalier
f3ec278e46 Merge pull request #4609 from sonwow/keyword-super
Make `super` a keyword
2013-01-24 11:17:52 -08:00
Graydon Hoare
e8f4da78e7 doc: fix tutorial unsafe blocks, r=burningtree. 2013-01-23 23:21:47 -08:00
Youngsoo Son
4b2aa286d8 Make super a keyword 2013-01-24 16:07:04 +09:00
Tim Chevalier
1d1b81143b Merge pull request #4589 from sanxiyn/doc-vec-match
doc: Document pattern matching on vectors
2013-01-23 14:38:34 -08:00
Seo Sanghyeon
92e52bc95e doc: Document pattern matching on vectors 2013-01-23 22:26:47 +09:00
Seo Sanghyeon
c379d96c67 doc: Document mutable function arguments 2013-01-23 17:20:36 +09:00
Tim Chevalier
e856606c0d Merge pull request #4562 from lbonn/loglevel
doc: fix log level ids
2013-01-21 19:53:24 -08:00
Tim Chevalier
3fac6f8b54 Revert "doc: Fix tutorial-ffi xfail-tests and update SHA1() to use size_t"
This reverts commit 50c8cbb25a.
2013-01-21 19:39:45 -08:00
Chris Peterson
50c8cbb25a doc: Fix tutorial-ffi xfail-tests and update SHA1() to use size_t 2013-01-20 22:56:45 -08:00
Chris Peterson
0b6487cf2c doc: Fix tutorial typo and remove unnecessary xfail-test 2013-01-20 22:56:45 -08:00
Chris Peterson
49e466f1e1 doc: Fix manual's link attributes example code 2013-01-20 22:56:45 -08:00
Laurent Bonnans
c3c90d2e4c doc: fix log level ids 2013-01-21 15:49:46 +09:00
Patrick Walton
9c24c6221e Merge pull request #4440 from pcwalton/tutorial
doc: Fold information from the memory model interlude in the tutorial elsewhere
2013-01-16 12:30:14 -08:00
Peter Williams
e4571446f9 doc: Fix spelling error in macro tutorial 2013-01-12 18:36:46 -05:00
Patrick Walton
f0fa67d6bf doc: Fold information from the memory model interlude in the tutorial elsewhere 2013-01-10 21:24:55 -08:00
John Clements
08275826ca corrected imprecision in description of mutable fields 2013-01-10 20:48:49 -08:00
Brian Anderson
22ed202b61 tutorial: Remove memory model section 2013-01-10 15:22:22 -08:00
Patrick Walton
2db3abddcd librustc: Make unqualified identifier searches terminate at the nearest module scope. r=tjc 2013-01-08 22:02:35 -08:00
Patrick Walton
44ab00ee37 Revert "librustc: Make unqualified identifier searches terminate at the nearest module scope. r=tjc"
This reverts commit a8d37af247.
2013-01-08 19:29:16 -08:00
Patrick Walton
a8d37af247 librustc: Make unqualified identifier searches terminate at the nearest module scope. r=tjc 2013-01-08 19:27:57 -08:00
Brian Anderson
62c7ca64f0 Merge remote-tracking branch 'superoptimizer/master' into HEAD
Conflicts:
	doc/tutorial.md
2013-01-04 17:31:12 -08:00
Mark Lacey
d94e9c0b04 Fix two minor issues in the tutorial.
Remove an extraneous 'then', and replace 'second' with 'first'.
2013-01-03 22:36:35 -08:00
Chris Peterson
16797fd525 doc: Fix some typos in the tutorial and reference manual 2012-12-31 13:46:52 -08:00
Tim Chevalier
cfb33fc23c Merge pull request #4311 from FranklinChen/fix-macro-tutorial
Remove semicolons at the end of macro_rules! definitions that cause compile failure
2012-12-30 15:53:18 -08:00
Andrew Paseltiner
4cb9247e3b doc: make small corrections to tutorial 2012-12-30 16:09:34 -05:00
Patrick Walton
4be7310be0 doc: Fix explanation and example of struct-like enum variants. rs=busted 2012-12-30 07:09:14 -08:00
Patrick Walton
4b3dd4b920 doc: Fix some broken tutorial examples. rs=bustage 2012-12-29 21:52:51 -08:00
Franklin Chen
6e7cf87101 Remove spurious semicolons at the end of macro_rules! definitions. 2012-12-29 01:37:00 -05:00
Tim Chevalier
09bb07bed9 Unfortunately, we can't embed cross-crate tests in the tutorial...
...as far as I know, anyway, so I xfailed this tutorial test.
2012-12-24 18:29:02 -08:00
Eric J. Holmes
8223a1278d Fix example. 2012-12-24 18:29:02 -08:00
Eric J. Holmes
40a3e20bbb Fix example. 2012-12-24 18:29:02 -08:00
Graydon Hoare
329316ce15 bump 0.5 => 0.6, redirect some URLs in docs. 2012-12-24 18:29:01 -08:00
Tim Chevalier
3cc0fbca5d doc: mention struct-like enum variants /cc #4217 2012-12-24 15:59:37 -08:00
Tim Chevalier
cf768ce1f4 Unfortunately, we can't embed cross-crate tests in the tutorial...
...as far as I know, anyway, so I xfailed this tutorial test.
2012-12-24 14:07:37 -08:00
Tim Chevalier
b1b0c297a4 Merge pull request #4249 from graydon/0.6-bump
bump 0.5 => 0.6, redirect some URLs in docs.
2012-12-23 13:47:11 -08:00
Tim Chevalier
50bb838389 Merge pull request #4272 from ejholmes/crates-minimal-example
Fix example in 13.3.
2012-12-23 13:38:48 -08:00
Eric J. Holmes
889e560ca5 Fix example. 2012-12-23 13:30:23 -08:00
Eric J. Holmes
0100b02b3a Fix example. 2012-12-23 13:26:12 -08:00
Graydon Hoare
dbd36111fe bump 0.5 => 0.6, redirect some URLs in docs. 2012-12-21 15:35:49 -08:00
Brian Anderson
8b98e5a296 doc: Mention argument bindings in manual 2012-12-20 17:01:38 -08:00
Brian Anderson
45e62d0a14 tutorial: Discuss argument patterns 2012-12-20 16:51:37 -08:00
Brian Anderson
d098faa855 tutorial: Clarify description of trait inheritance 2012-12-20 16:36:13 -08:00
Brian Anderson
21c9d0858b tutorial: Fix broken examples 2012-12-20 16:32:44 -08:00
Brian Anderson
f26df46a12 tutorial: Re-remove core:: prefix from some examples 2012-12-20 16:32:44 -08:00
Brian Anderson
d38f784da6 tutorial: Typo 2012-12-20 16:32:44 -08:00
Brian Anderson
b7354f114d tutorial: Clean up language about syntax extensions 2012-12-20 16:32:43 -08:00
Brian Anderson
30fac74bf3 tutorial: Try to fit the early discussion of :: in better 2012-12-20 16:32:43 -08:00
Brian Anderson
cbddd5ed34 tutorial: Remove some trivia about operators 2012-12-20 16:32:43 -08:00
Brian Anderson
2f615dc965 tutorial: Editing 2012-12-20 16:32:43 -08:00
Brian Anderson
e4b3915393 tutorial: Fix example in syntax basics section 2012-12-20 16:32:43 -08:00
Brian Anderson
1983e540e6 tutorial: Update scope 2012-12-20 16:32:43 -08:00
Brian Anderson
072017e5ef tutorial: Mention rusti with other tools 2012-12-20 16:32:43 -08:00
Brian Anderson
201039cf0d tutorial: Discuss the primitive types along with their literals 2012-12-20 16:32:43 -08:00
Brian Anderson
107b2e5348 tutorial: It doesn't matter that Rust identifiers are the same as C 2012-12-20 16:32:43 -08:00
Brian Anderson
36e2c100bf tutorial: Integrate constants into main intro text 2012-12-20 16:32:43 -08:00
Brian Anderson
e06ca65244 tutorial: Remove the section on constants
We can mention that constants are declared with 'const' in one line.
Don't need an entire section.
2012-12-20 16:32:42 -08:00
Brian Anderson
0b0b50aaae tutorial: Remove the entire 'Types' section
It's not interesting

/cc: #4217
2012-12-20 16:32:42 -08:00
Brian Anderson
64681213af tutorial: Remove mutable vector syntax 2012-12-20 16:32:42 -08:00
Brian Anderson
e0f9f89c65 tutorial: Remove confusing discussion about semicolons
This takes up a lot of words and isn't very clear. The previous
discussion gets they idea across.

/cc: #4217
2012-12-20 16:32:42 -08:00
Brian Anderson
9cbc0fd0d9 tutorial: Fix formatting 2012-12-20 16:32:42 -08:00
Brian Anderson
a24b9e038a tutorial: update intro 2012-12-20 16:32:42 -08:00
Brian Anderson
f15ccc06f0 tutorial: Update for moves based on type
/cc: #4217
2012-12-20 16:32:42 -08:00
Brian Anderson
41870da5ad tutorial: Typos 2012-12-20 16:32:42 -08:00
Brian Anderson
191b328f31 tutorial: Move method discussion after closures, before generics
/cc: #4217
2012-12-20 16:32:42 -08:00
Brian Anderson
af5cd341d3 Move mast static method to the section on methods
/cc: #4217
2012-12-20 16:32:42 -08:00
Brian Anderson
42ab33e572 Use explicit self in rest of tutorial
/cc: #4217
2012-12-20 16:32:42 -08:00
Brian Anderson
171e6a16f7 tutorial: Rewrite method section to deal with explicit self
Has to be moved until after the pointer discussion.

/cc: #4217
2012-12-20 16:32:41 -08:00
Brian Anderson
7d2c2dbf4b tutorial: Reorder sections on traits
/cc: #4217
2012-12-20 16:32:41 -08:00
Brian Anderson
850050b7df doc: 'trait constraints' -> 'inheritance'. Expand
/cc: #4217
2012-12-20 16:32:41 -08:00
Graydon Hoare
66aadecfee doc: describe the Drop trait. cc: #4217 2012-12-20 16:26:11 -08:00
Tim Chevalier
8554d5e710 doc: Mention tuple structs
/cc: #4217
2012-12-19 21:52:03 -07:00
Tim Chevalier
b99a2542f3 docs: mention static methods
/cc #4217
2012-12-19 21:32:19 -07:00
Tim Chevalier
2d313fe501 Update docs to mention trait constraints; also fix failing doc tests
/cc #4217
2012-12-19 20:38:28 -07:00
Brian Anderson
6742c982a4 Bump version numbers in docs 2012-12-19 18:03:03 -08:00
Graydon Hoare
e0072e39a7 doc: structure expressions. cc: #4217 2012-12-19 17:24:19 -08:00
Graydon Hoare
46766974c7 doc: mention moved and copied types. cc: #4217 2012-12-19 16:55:34 -08:00
Isaac Aggrey
63232d6cf1 Fix doc typo 2012-12-19 12:46:24 -06:00
Brian Anderson
263136d389 'trait instance' -> 'object' 2012-12-18 17:03:56 -08:00
Brian Anderson
80a4769318 Update tutorial on generics. #4217 2012-12-18 16:28:40 -08:00
Graydon Hoare
6d4621d85f doc: a little more material on object types, part of #4217. 2012-12-18 14:37:18 -08:00
Paul Stansifer
7c103f2da9 Add a section to the macro tutorial about recursive macros. 2012-12-16 18:45:54 -05:00
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