Since the first Rust Doc Days went well, we the Rust Documentation Team have decided to do it again. The second Rust Doc Days will happen after RustConf, likely during the end of September. But before we can schedule the event, we need your help.
For the second Rust Doc Days, we want you to propose crates that need better documentation. This time we’d prefer to focus on community crates. We’ve already nominated serde, but we need your thoughts. Let us know by leaving a comment below.
log - in particular it would be great for it to lead you to some actual logger implementations. I happen to know that env_logger is the standard, but that’s not indicated in the docs, and I don’t know any other loggers and don’t know how to find them.
nom looks like a really cool library. I have attempted to learn it a couple of times but it’s not that easy to start with because it’s mostly using macros. I think nom is missing a lot of simple examples or a beginners guide to explain the basics.
I second this. My biggest problem with it is that I have no idea which operators accept byte slices, which accept strings, which accept both and which accept both, but treat both as byte streams (which might or might not matter). For many operators the documentation simply does not say and it’s hard to say from the source as the types are often inferred and so not mentioned in code either.
It would be particularly nice to modify the examples to contain non-ascii characters in all places that work on strings and chars to demonstrate they are handled properly (from brief look at the code I suspect it would find some bugs, too)—or clear information that it works on bytes, not utf-8 sequences.