Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

I would really love if the reference docs pointed to the underlying code. Many times I'll skim through the reference docs looking for something that I need...then search github for the same section in code so that I can see how it is actually used (or implemented, since the compiler is often the best place to learn Rust itself).

Would be great if the docs just linked straight to the function/crate in github.



This is actually in the "reference" implementation of the current web interface: http://seld.be/rustdoc/master/std/from_str/trait.FromStr.htm... (the [src] link.)

(That feature has yet to be ported to the Rust port of the HTML generator though.)


I think it would be better if it was HTML in the page, github might be down, or you could use it offline (like travelling in a plane, coding).



Wow, you guys are fast :)


Even better: alexcrichto is ridiculously fast, and [src] links will be landing in a few hours (assuming tests pass) in https://github.com/mozilla/rust/pull/9577.

Example: http://www.contrib.andrew.cmu.edu/~acrichto/doc/std/from_str...


Come and join us and be fast!


I'm working on something Rusty https://github.com/DanielFath/xml_parser ;) as my side project. But it's so woefully incomplete I am ashamed of showing it. It's mostly based on

- https://github.com/Florob/RustyXML

- http://fantom.org/doc/xml/index.html

Once that is finished, I might come and help on the Core/Servo. I just don't think I'd be much of a help if I don't use/know Rust/C++ very well.


rust-http was the very first thing that I worked on when I came to Rust, not knowing the language up until then. And it hasn't been turning out too badly.


> And it hasn't been turning out too badly.

Yeah it's been very smooth sailing :) Only pain point was @ pointers in BytesReader interface, but aside from that it's way less bumpy than anticipated.


We generate a PDF of the documentation too.


Here's the issue for adding that capability directly to rustdoc: https://github.com/mozilla/rust/issues/2072




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: