tikv
Make a pass over documentation
Maybe I'm just being dense but it seems like docs.rs doesn't have any mention of the push feature except the aside in the prose on the first page. The example worked fine, of course, once I found it.
One notable problem in current documentation is that, the documentation (like members functions) of alias types are not shown. (example) This makes it very unfriendly for our most commonly used metrics because most of them are defined using an type alias over a generic type.
@nrc @brson Do you have some ideas about how we can improve it?
Do you have some ideas about how we can improve it?
Could use newtypes instead of type aliases? (That would have other advantages too) Otherwise, you could link to the docs for the aliased type in the documentation for the alias (you can already click through, but by adding text you could point users to the docs more explicitly). You could also discuss with the rustdoc team whether they would take a PR to change the behaviour (I expect that for type Bar = Foo<f32>, showing the docs for Foo would be very easy, but showing the docs for Foo<f32> would be pretty difficult).
Newtypes do look pretty reasonable though there are a number of impls to fill in.
But also it seems a reasonable idea to me that rustdoc should duplicate the appropriate impls in the newtype docs. Someone could file a feature request upstream and see if they are open to it.
@nrc
Could use new types instead of type aliases?
Thanks for the suggestion! I will try it!