[rust-dev] Rust's documentation is about to drastically improve

Zoltán Tóth zo1980 at gmail.com
Wed Jun 18 04:10:59 PDT 2014


Please do not create examples for _all_ entities in the API doc. In case of
trivial entities [like Iterator::filter] it would just unnecessarily
decrease the conciseness of the doc. Also: think about the amount of update
this may make necessary in case Rust language syntax changes.


On Tue, Jun 17, 2014 at 7:43 AM, Steve Klabnik <steve at steveklabnik.com>
wrote:

> Thanks everyone! :D
>
> > Steve, let us know how we can help.
>
> I think the best thing that the community can do is go through and add
> examples in the API docs. I want to have 100% of the standard library
> having examples by 1.0, but it's last on my list. The reason is that
> they're nice, small chunks that can easily be tackled by others,
> whereas things like writing a whole tutorial are large, and take a
> while. I'd rather spend my time on those things first, and then get to
> the API stuff. But I can't tell you how valuable it is to look
> something up, and then cut and paste from the examples.
> _______________________________________________
> Rust-dev mailing list
> Rust-dev at mozilla.org
> https://mail.mozilla.org/listinfo/rust-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.mozilla.org/pipermail/rust-dev/attachments/20140618/3edea81b/attachment.html>


More information about the Rust-dev mailing list