texpresso icon indicating copy to clipboard operation
texpresso copied to clipboard

Documentation on `docs.rs` is incomplete

Open torokati44 opened this issue 1 year ago • 1 comments

At the moment, https://docs.rs/texpresso/2.0.1/texpresso/ describes only a handful of API items, but nothing that would tell me how to actually use this crate. Could you please try brushing up on it a little - at least make the generator also include undocumented items? The CLI example application included in the repo is also nice of course - but it was not the first place I went to looking for info on how to make use of Texpresso.

torokati44 avatar Mar 12 '24 16:03 torokati44

Hmm, not sure how to actually do that? Either way, adding a #![warn(rustdoc::missing_crate_level_docs)] and possibly other relevant attributes sounds like a good idea.

jansol avatar Mar 14 '24 14:03 jansol