3 ms·
Yes, this is very true of most rust docs that I've seen as well. Lots of libraries have the auto generated docs describing the functions and types usually at a
by ketralnis 9y ago
Yes, this is very true of most rust docs that I've seen as well. Lots of libraries have the auto generated docs describing the functions and types usually at a per-module level but fewer have anything higher-level
- simias 9y agoMost of the time I find that the lib's github's README.md contains the introduction and overview that I want to understand how the library works. Unfortunately it's not in the docs themselves, but I hear that the Rust team is working on improving that. See for instance the "image" crate docs: https://docs.rs/image/0.13.0/image/ https://docs.rs/image/0.13.0/image/ A simple API doc, I don't know where to start. But then if I go to the repo I find a nice intro with some example code: https://github.com/PistonDevelopers/image/blob/master/README.md https://github.com/PistonDevelopers/image/blob/master/README...
- aturon 9y agoYes, and that's definitely something we hope to address with the Blitz, both by beefing up top-level library docs, and through the Cookbook.