Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on docs.rs is incomplete #8

Open
torokati44 opened this issue Mar 12, 2024 · 1 comment
Open

Documentation on docs.rs is incomplete #8

torokati44 opened this issue Mar 12, 2024 · 1 comment

Comments

@torokati44
Copy link

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.

@jansol
Copy link
Owner

jansol commented Mar 14, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants