On 12.08.2013 19:27, Alex Crichton wrote:
> This is awesome! If you're taking suggestions, it seems like one case
> can be improved. If you just heard about this TreeMap thing, you'd go
> to the dox, search for treemap (awesome live update btw), hit the
> first link, and then get bombarded with a *lot* of type signatures.
> 
> If all you wanted to find was the signature for "pop", you've got to
> scroll down aways and find the small "pop" word. It'd be kinda nice to
> all instance methods in a nice easily-scannable location which
> eventually had links with something along the lines of "provided by
> the XXX trait" or something like that. I'm also a fan of large-ish
> documentation pages. Currently there's only ever one method per page,
> but I personally prefer having all the methods all on one page. That
> way I can just scan up and down the page (and use anchors for links)
> to find what the method was that I needed. This isn't really major
> though.

Agreed, this is still a bit confusing. There is a lot of info on structs
and it's hard to display it all without making a mess, but I'll
definitely try to improve this over time :)

> Also, it appears that type parameterization for return types isn't
> showing up just yet, the return value of "pop" is just Option, not
> Option<V>.

Thanks - I'll get that fixed, simple omission because we didn't have
type params early on.

> Finally, perhaps all of the types/traits don't have to be listed with
> their full paths? It clutters up things like the Encodable
> implementation for TreeMap, and everything is a hyperlink anyway so it
> should be pretty easy to find the full path.

module-local types are shown in short form, and the others are shown
with fully qualified name for now. One improvement I have planned is to
show short form for whatever is in the prelude as well, that should help
in some cases. But yeah it is in some case a bit messy and quite long so
perhaps we can do short-form everywhere with the fully qualified name in
the link's title attribute. I'll play with it and see.

Cheers

-- 
Jordi Boggiano
@seldaek - http://nelm.io/jordi
_______________________________________________
Rust-dev mailing list
Rust-dev@mozilla.org
https://mail.mozilla.org/listinfo/rust-dev

Reply via email to