3 ms·
Does rust-doc make a distinction between a user guide and a reference? A user guide is basically a book that goes over all the general features of the library.
by imtringued 7y ago
Does rust-doc make a distinction between a user guide and a reference? A user guide is basically a book that goes over all the general features of the library. A reference provides information about the API of the library.
- steveklabnik 7y agoSo, the terminology I've used since around 2013: * API documentation: stuff like "type signatures" * Reference documentation: the specification of the language * Tutorials: long-form text that explains things I gave a talk about the Bay Area Rust Meetup about this, but it seems like maybe it's lost to history :( Anyway, rustdoc makes this distinction in a sense because it only provides API documentation, which I believe is what you're calling "reference" documentation. mdbook provides the longer form factor. Most libraries don't have a language spec, since they're not a language, so they have categories one and three.
- devit 7y agoThe documentation for crates, modules or struct/enum often contains a "user guide" for the item in question. I think that's better than a separate book, since in most cases that separate book would never get written.