rust/doc
Felix S. Klock II 5b10f4e117 Miscellaneous documentation additions.
Added notes explaining how [expr, ..expr] form is used, targeted at
individuals like me who thought it was more general and handled
dynamic repeat expressions.  (I left a TODO for this section in a
comment, but perhaps that is bad form for the manual...)

Added example of `do` syntax with a function of arity > 1; yes, one
should be able to derive this from the text above it, but it is still
a useful detail to compare and contrast against the arity == 1 case.

Added example of using for expression over a uint range, since someone
who is most used to write `for(int i; i < lim; i++) { ... }` will
likely want to know how to translate that form (regardless of whether
it happens to be good style or not for their use-case).

Added note about the semi-strange meaning of "fixed size" of vectors
in the vector type section.
2013-03-26 14:18:48 +01:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
lib.css Establish 'core' library separate from 'std'. 2011-12-06 12:13:04 -08:00
manual.css Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
prep.js fix escape 2012-10-05 12:41:00 -07:00
README Added a readme explaining how to generate html from markdown docs w/o node 2012-11-18 09:08:31 -08:00
rust.css docs: Tweak style 2012-09-30 21:35:32 -07:00
rust.md Miscellaneous documentation additions. 2013-03-26 14:18:48 +01:00
tutorial-borrowed-ptr.md docs: update to avoid mention of const. 2013-03-25 15:53:02 -07:00
tutorial-ffi.md librustc: Convert all uses of assert over to fail_unless! 2013-03-07 22:37:57 -08:00
tutorial-macros.md Copyedit macro tutorial 2013-03-22 16:11:27 -07:00
tutorial-tasks.md librustc: Convert all uses of assert over to fail_unless! 2013-03-07 22:37:57 -08:00
tutorial.md docs: update to avoid mention of const. 2013-03-25 15:53:02 -07:00
version_info.html.template Rename the template for version_info.html 2012-08-20 14:04:12 -07:00

The markdown docs are only generated by make when node is installed (use
`make doc`). If you don't have node installed you can generate them yourself. 
Unfortunately there's no real standard for markdown and all the tools work 
differently. pandoc is one that seems to work well.

To generate an html version of a doc do something like:
pandoc --from=markdown --to=html --number-sections -o build/doc/rust.html doc/rust.md && git web--browse build/doc/rust.html

The syntax for pandoc flavored markdown can be found at:
http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown

A nice quick reference (for non-pandoc markdown) is at:
http://kramdown.rubyforge.org/quickref.html