0
0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-29 18:06:44 +01:00
rust/doc
bors 10faa521ae auto merge of #5188 : ben0x539/rust/doc-call-generic-fn, r=catamorphism
I have seen a few people confused on how to explicitly instantiate generic functions, since the syntax differs from C++'s and C#'s, which is probably where most people asking questions about generic functions are coming from. The only use of the `::<T>` syntax in the reference right now is in the section on paths, which is possibly not where someone trying to find out about generic functions is going to start looking. The tutorial doesn't mention it at all, but I think it's all right to make the reference a tiny bit more redundant and avoid stuffing the tutorial with syntax details.

----

The "Generic functions" subsection mentions that generic functions are instantiated based on context, so let's also mention right away (with a link to the #paths section) that an explicit form is available.

This also adds an example that explicitly instantiates a generic function to the function call expression section.
2013-03-02 01:00:41 -08:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
lib.css
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 auto merge of #5188 : ben0x539/rust/doc-call-generic-fn, r=catamorphism 2013-03-02 01:00:41 -08:00
tutorial-borrowed-ptr.md doc: Remove references to mut fields. rs=demuting 2013-02-26 10:02:36 -08:00
tutorial-ffi.md doc: Remove references to mut fields. rs=demuting 2013-02-26 10:02:36 -08:00
tutorial-macros.md remove die definition and use in doc tests 2013-02-14 17:33:16 -08:00
tutorial-tasks.md Fix unused imports in the tutorials 2013-02-26 17:52:16 -05:00
tutorial.md librustc: Enforce cross-crate method privacy 2013-02-28 11:32:26 -08:00
version_info.html.template

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