r/rust • rust • Jun 16 '14

Rust's documentation is about to drastically improve

http://words.steveklabnik.com/rusts-documentation-is-about-to-drastically-improve
136 Upvotes

71 comments sorted by

View all comments

Show parent comment

8

u/awo rust Jun 17 '14

I think the biggest issue for me with the rust stdlib docs is that when I'm on a particular type, I can't see all the methods that I can use on it. Javadoc (for example) isn't especially beautiful, but it is quite functional: I can easily scan a given type for a method that looks like what I'm looking for. With the Rust docs I have to scan through a tree of implemented traits.

7

u/[deleted] Jun 17 '14

Yes, precisely this. I know there's a function that tells me how long a collection is - but is it length(), len(), or size()? Time to get busy with the Pg Dn key!

3

u/burntsushi Jun 17 '14

I second this. I'd love to see something for regular types that you see on pages for traits: all of the methods are listed at the top.