rust/doc
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
..
lib Overhaul mods and crates section of tutorial 2012-10-06 22:24:15 -07: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 doc typo 2013-01-25 11:58:33 -08:00
tutorial-borrowed-ptr.md Fixed two examples of erroneous code so their errors match expectation. 2013-01-29 11:28:52 +01:00
tutorial-ffi.md doc: fix tutorial unsafe blocks, r=burningtree. 2013-01-23 23:21:47 -08:00
tutorial-macros.md doc: Fix spelling error in macro tutorial 2013-01-12 18:36:46 -05:00
tutorial-tasks.md doc: Fix tutorial typo and remove unnecessary xfail-test 2013-01-20 22:56:45 -08:00
tutorial.md Fix two code examples in main rust tutorial. 2013-01-29 11:28:52 +01: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