kyren / piccolo

An experimental stackless Lua VM implemented in pure Rust
Creative Commons Zero v1.0 Universal
1.62k stars 59 forks source link

use `#[doc(inline)]` for re-exports #41

Closed jrobsonchase closed 4 months ago

jrobsonchase commented 4 months ago

tbh, it feels like this should be the default for re-exported things. Rust doc search is pretty awful when they aren't inlined, since you end up seeing two items in the results, one of which is the re-export which requires yet another click to get to the page you're actually looking for.

Alternatively, the target of the re-export could be made non-public, which would have the same effect as far as docs go.

kyren commented 2 months ago

I may change this back, I think the main problem was that almost none of the types were documented at all, and rustdoc behaves weirdly with re-exports when the type has no documentation.

Once every type is documented, I think removing it again will be cleaner.