It’s a great feature, but the Rust documentation generally assumes you have a great amount of in-depth knowledge about the language and the specific library you’re using. Often all you’re getting is a list of methods, struts, and traits, and brief descriptions like “frobble_widget frobbles the widget assuming the requirements are met”.
I find the documentation on PHP libraries often a lot better. Technically both support generating the docs from the source code, but the Rust people seem to write worse documentation somehow.
A real shame, because the documentation can contain quick tests that can serve as excellent example code!
It’s a great feature, but the Rust documentation generally assumes you have a great amount of in-depth knowledge about the language and the specific library you’re using. Often all you’re getting is a list of methods, struts, and traits, and brief descriptions like “frobble_widget frobbles the widget assuming the requirements are met”.
I find the documentation on PHP libraries often a lot better. Technically both support generating the docs from the source code, but the Rust people seem to write worse documentation somehow.
A real shame, because the documentation can contain quick tests that can serve as excellent example code!