On Fri, Apr 5, 2013 at 11:44 AM, Steve Klabnik <[email protected]> wrote:
> Now that the language has largely settled down, I'd like to start writing
> more docs. I've gotten a few patches in, but want to contribute more.
>
> Two things:
>
> What needs documented the most? Where should I start to be most effective?
>

There's a bug open on documenting core::io; I think that would be
good. Ask questions on IRC if there's stuff that's not clear; I'm sure
there is stuff that's not clear! I think since core and std are so
pervasive, starting by documenting them (in the way you've already
done very well for some modules with one comment per function and
examples where possible) would be useful.

> In Ruby-land, we have doc percentages published. Like this:
> http://documenting-ruby.org/assets/undocumented_core.txt Does this exist for
> Rust?
>

It doesn't exist as far as I know, but would be great to have for
Rust, and it probably wouldn't be hard to modify rustdoc to do it.

Cheers,
Tim


-- 
Tim Chevalier * http://catamorphism.org/ * Often in error, never in doubt
"Too much to carry, too much to let go
Time goes fast, learning goes slow." -- Bruce Cockburn
_______________________________________________
Rust-dev mailing list
[email protected]
https://mail.mozilla.org/listinfo/rust-dev

Reply via email to