Good crate documentation example

Hello

I am writing the documentation for a crate and trying to follow the guidelines as much as possible.
Can you provide me with some crates that have particularly good documentation?

Thank you

1 Like

I like signal-hook.

I’m also proud of csv, where I made sure to include tons of examples, since I anticipate a lot of beginners using csv as a possible entry point into the language.

3 Likes

Thank you

I also noticed that *-sys crates have no docs at all, why?

1 Like

*-sys crates wrap FFI libraries, so the documentation should be found in that library (if any);

Rust users should not be using a *-sys crate directly, only the author of the safe wrapper.

3 Likes

When in doubt, stdlib is a good reference. It helps to clone the rust repository locally for quick lookup.

1 Like

Actix-web is also well documented and has an entire repo of examples.